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

...

OverflowError: n too large

"""

import math

if not n >= 0:

raise ValueError("n must be >= 0")

if math.floor(n) != n:

raise ValueError("n must be exact integer")

if n+1 == n: # catch a value like 1e300

raise OverflowError("n too large")

result = 1

factor = 2

while factor <= n:

result *= factor

factor += 1

return result

if __name__ == "__main__":

import doctest

doctest.testmod()

膳绫擎是官网供给的一个求N的阶乘函数示例，在docstring 中经由过程 >>>符号来开端一个单位测试，之后换行输入预期结不雅即可。实际上就是复制粘贴一下调试过程和结不雅，真的再简单不过了，想实现TDD也是以变得异常轻松。

用注释写API文档:apidoc

在我们完成机械进修模型后，想要供给一个对外办事的接口以供献我们的算力时就须要完全的API文档，也是经由过程API的调用才能为我们的模型供给源源赓续的校验数据，对于晋升模型效不雅有异常实际的意义。对大年夜多半人而言调用API来完成开辟都是一件比较高兴的工作，因为我们可以少做很多工作就可以实现强大年夜功能。然而，当我们须要对外供给API时就要面对不一样的考验了，接口鉴权、接口设计、版本控制、并发问题、日记埋点…这些都是须要面对的新问题，而应用 apidoc 可以很好地解决这些API文档中常见的诸多问题，相当于经由过程模板晋升了我们的接口设计的才能。

apidoc为Python供给了一种类似于 docstring 的方法来写API文档，大年夜语法上看比较类似于 R中的roxygen，都须要用户以 @xxx 符号作为一个开首，随后书写相干的定义和功能。

举个例子：

下面是一个API接口的定义办法，最核心的部分就是

路由
GET/POST办法
名称/分组
参数与调用例子

(这岁首没有效例的代码都是耍地痞)

""" 
 
@api {get} /user/:id Request User information 
 
@apiName GetUser 
 	
			 2/5   首页 上一页 1 2 3 4 5 下一页 尾页	
			

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


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