当前位置:  开发笔记 > 编程语言 > 正文

为Python类生成文档

如何解决《为Python类生成文档》经验,为你挑选了2个好方法。

我即将开始一个项目,我将成为唯一一个做实际代码的人和两个经验不足的程序员(可怕的想象自己经验丰富!)将会一直在观看并对程序提出建议.

是否有一个好的(免费)系统,我可以根据我编写的代码提供类和函数的文档?它可能会帮助他们掌握数据结构.



1> Greg Hewgill..:

我使用epydoc从嵌入式文档字符串生成Python模块的文档.它非常易于使用,并以多种格式生成漂亮的输出.



2> JimB..:

python.org现在使用sphinx作为它的文档.

我个人喜欢sphinx在epydoc上的输出.我还觉得重构文本在文档字符串中比epydoc标记更容易阅读.

推荐阅读
帆侮听我悄悄说星星
这个屌丝很懒,什么也没留下!
DevBox开发工具箱 | 专业的在线开发工具网站    京公网安备 11010802040832号  |  京ICP备19059560号-6
Copyright © 1998 - 2020 DevBox.CN. All Rights Reserved devBox.cn 开发工具箱 版权所有