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

2024-11-14 13:03:46
推荐回答(3个)
回答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文件夹中看到生成好的文档了,还支持查找的功能

回答2:

你可以使用doxygen或者Sphinx,现在python文档就是使用Sphinx生成的,你可以到官网看一下具体的使用方法。

如果解决了您的问题请采纳!
如果未解决请继续追问

回答3:

什么叫从注释生成文档?
是从一个脚本中提取出所有的注释,再写入一个文档中吗?
直接自己写就可以了啊 使用open()打开文件 open打开一个PY文件 和TXT文件是一样的
然后while读取每一行 判断是否有# 有的话 一行的#后面的就写入到另一个文件中