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

Python 程序有什么好的自动从注释生成文档的方法,第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文件夹中看到生成好的文档了,还支持查找的功能

C语言的侍芦程序的话,先点击开始菜单-》运行-》输入“CMD”。枯谈启

假设你的程序名字是1.exe

在打开的窗口输入1.exe>>c:\jieguo.txt

这样运行完了在C盘的根目录就可以看到一个jieguo.txt的文件,运行的没如结果就在里面了,慢慢看吧


欢迎分享,转载请注明来源:内存溢出

原文地址: http://outofmemory.cn/yw/12314305.html

(0)
打赏 微信扫一扫 微信扫一扫 支付宝扫一扫 支付宝扫一扫
上一篇 2023-05-24
下一篇 2023-05-24

发表评论

登录后才能评论

评论列表(0条)

保存