21

用于记录 python 源代码的约定和工具有什么？

4

5 回答 5

38

约定：PEP 257和PEP 8。请注意，文档字符串可以用reStructuredText编写

生成文档的工具：例如Sphinx

于 2009-03-11T16:56:58.783 回答
16

首先，使用 RestructuredText 格式在您的文档字符串中添加注释。

其次，得到狮身人面像。

第三，创建一个使用autodoc 扩展的索引。

然后，运行 Sphinx 以获得非常好的文档。

于 2009-03-11T17:08:39.193 回答
10

Epydoc也是记录源代码的好工具，可以将类、模块、变量等交叉引用到 HTML、PDF、LaTeX 中。也画了一些漂亮的类继承图。它被许多开源项目所使用，因此它得到了相当积极的开发。

于 2009-03-11T17:06:07.780 回答
6

将代码文档放在代码本身中非常好。看：

于 2009-03-11T17:00:23.360 回答
1

使用带有 doxygen 的 doxypy 过滤器也是一件好事

于 2014-03-07T10:20:16.920 回答