Python 程序有什么好的自动从注释生成文档的方法

Question

如题所述

Answer 1

用Sphinx
以win32系统为例，最简单的安装方式是在Dos下输入如下代码
pip install -U sphinx
安装好了之后，用最简单的半自动生成API文档的方式进行
例如：你的python安装在C:\python27， 想要给flask包自动制作文档，制作完成的文档放在C:\python_doc\flask的文件夹
代码如下：
sphinx-apidoc -F -o C:\python_doc\flask C:\python27\lib\site-packages\
（此处-o应紧跟输出文件夹，不然会产生一个-F的文件夹，多谢@Hyacz）
然后进入C:\python_doc\flask文件夹
cd C:\python_doc\flask
此文件夹下有一个make.bat文件，再执行一下
make html
然后就能在\_build\html文件夹中看到生成好的文档了，还支持查找的功能

Answer 2

1对于函数字符串文档：
（1）定义方式：
可以由成对单引号或双引号创建单行字符串文档
或使用成对三元引号'''创建多行字符串文档
（2）输出字符串文档
使用help(函数名)输出函数文档及参数列表
或通过 函数名.__doc__来只输出文档字符串
2对于一般注释，本人暂没有形成规范的方法本回答被提问者采纳