Skip to main content

工具列表

Doctest

将读取所有内嵌的看起来像Python命令行输入(以“>>>”为前缀)的文档字符串,并运行,以检查命令输出是否匹配其下行内容。这允许开发人员在源码中嵌入真实的示例和函数的用法。此外,它还能确保代码被测试和工作。

def my_function(a, b):
"""
>>> my_function(2, 3)
6
>>> my_function('a', 3)
'aaa'
"""
return a * b

sphinx - 根据代码注释生成文档