python的代码文档

Question

有关记录python源代码的约定和工具的内容是什么？

Answer 1

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

编写

用于生成文档的工具：例如Sphinx

Answer 2

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

其次，获取sphinx。

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

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

Answer 3

Epydoc也是一个很好的工具，用于记录源代码，并处理交叉引用类，模块，变量等到HTML，PDF，LaTeX。绘制一些很好的类继承图。它被许多开源项目使用，因此它得到了相当积极的开发。

Answer 4

将代码文档放在代码本身中是非常好的。参见：

• PEP 257 -- Docstring Conventions
• PEP 8 -- Style Guide for Python Code

Answer 5

使用Doxypy过滤器和doxygen也是一件好事