Python开发者面向文档编程的正确姿势

@apiGroup User

@apiParam {Number} id Users unique ID.

@apiSuccess {String} firstname Firstname of the User.

@apiSuccess {String} lastname Lastname of the User.

"""

起首，下载示例源码

git clone https://github.com/apidoc/apidoc 
 
cd apidoc

然后，安装 apidoc 组件

sudo npm install apidoc -g

接着，应用官方代率攀来制造一个例子，并且拜访即可。

Python开辟者面向文档编程的┞俘确姿势

apidoc -i example/ -o output/ -t template/ 
 
open output/index.html

fiannceR.py tcp 0.0.0.0 3838

-o:output，表示输出文件夹

几个参数的含义如下：

-i:input，表示输入的文件夹

-t:template，表示模板文件，经由过程调换模板我们可以修改文档皮肤

在 example 文件夹下，我们须要在apidoc.json 中填写设备文件，定义文档的header和footer部分内容，其余的文件会被主动辨认出个中的docstring作为API文档的一部分。

单位测试是代码开辟环节必弗成少的一环，对于Bug定位和代码质量而言是异常重要的。如今最广为人知的单位测试框架就是Unittest，它借鉴了Java中成熟的单位测试框架的JUnit。即使像Django还对这个框架有特别的支撑，然而在实现Unittest的时刻会感到确切比较烦琐，setup，teardown…在保护单位测试的时刻很多时刻感到力不大年夜心。

因为apidoc的官方文档异常简单清楚，所以这里不过多强调语法。

apidoc 还为我们供给了接口调试的功能，在实际应用的时刻要留意：

我们须要一个web server 才可以应用这个接口调试的功能

我们可以直接撸一个官方法例来进修若何应用apidoc。

要留意跨域的问题。

经由过程版本比较，我们还可以快速排查API接口的变更情况。须要留意的是这个功能请求我们要将汗青的文档记录也要保存在该目次下的文件中，平日我们可以把汗青的注释输出到一个特定文件中保存。

总的来说，固然，API文档的书写并不是一件难度异常高的工作，却能表现体系募块设计和用户体验设计的功力，我们应当对那些无代码示例，无版本控制的API文档say no!

用注释写敕令行接口:docopt

应用docopt，我们可以在注释中直接声明文件的敕令行传入参数，而不须要经由过程 argvs变量来捕获输入值袈滟做断定，这在调用运维脚本或者若干义务调剂脚本的时刻尤其管用，极大年夜地晋升了CLI的效力。

举个例子：(此处代码仅供参考)

"""Usage: 
 
  fiannceR.py tcp <host> <port> [--timeout=<seconds>] 
 
  fiannceR.py serial <port> [--baud=9600] [--timeout=<seconds>] 
 
  fiannceR.py -h | --help | --version 
 
  
 	
			 3/5   首页 上一页 1 2 3 4 5 下一页 尾页	
			

　　推荐阅读
　　人工智能行业薪酬曝光，是时候转行了
            
            人工智能可谓是今朝最热点的行业，大年夜走在前沿的科技公司，到尽力立异的传统行业，几乎都想把握这个新“风口”。而人工智能的核心就是人才，热点的行业通平平易近味着工作机>>>详细阅读


本文标题：Python开发者面向文档编程的正确姿势
地址：http://www.17bianji.com/lsqh/36964.html
 1/2    1