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文件夹中看到生成好的文档了,还支持查找的功能

tool builder

工具建造者

例句

1.You can also use these languages in the comment builder tool.

还盯咐稿可以在注释生成器工凯孝具中使用这些语言。

2.Create your own data objects that are processed through the workflow builder tool.

创建自己的通过工作流构建器工具处理的数据对象。

3.The Virtual Application Builder tool is used to build out your virtual application pattern.

VirtualApplicationBuilder工具用于构建您的虚拟应用程序模式。

4.Tool builder identification tag should be on die if required by Project Manager.

如项目经理要求模具识别标签应贴在模具上。

5.A developer can create a query table definition using the Query Table Builder tool.

开发人员可以使用QueryTableBuilder工具创建查询表简坦定义。


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

原文地址: https://outofmemory.cn/yw/12475796.html

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

发表评论

登录后才能评论

评论列表(0条)

保存