Epydoc is also a good tool for documenting source code, and handles cross-referencing classes, modules, variables, etc, into HTML, PDF, LaTeX. Draws some nice class inheritance diagrams too. It's used by a number of open-source projects, so it's fairly actively developed.
发布评论
评论（5）
约定：PEP 257 和 PEP 8。
请注意，文档字符串可以用 reStructuredText 编写
用于生成文档的工具：例如 狮身人面像
Conventions: PEP 257 and PEP 8.
Note, that docstrings can be written in reStructuredText
Tools for generating documentation: for example Sphinx
首先，使用 RestructedText 格式将注释放入文档字符串中。
其次，获取sphinx。
第三，创建一个使用 autodoc 扩展 的索引。
然后，运行 Sphinx 以获得非常好的文档。
First, put comments in your docstrings using RestructuredText format.
Second, get sphinx.
Third, create an index that uses the autodoc extension.
Then, run Sphinx to get really nice documentation.
Epydoc 也是一个记录源代码的好工具，可以处理交叉引用类、模块、变量等，转换为 HTML、PDF、LaTeX。 还画了一些漂亮的类继承图。 它被许多开源项目使用，因此它的开发相当活跃。
Epydoc is also a good tool for documenting source code, and handles cross-referencing classes, modules, variables, etc, into HTML, PDF, LaTeX. Draws some nice class inheritance diagrams too. It's used by a number of open-source projects, so it's fairly actively developed.
将代码文档放在代码本身中非常好。 请参阅：
It's very nice to put code documentation in the code itself. See:
将 doxypy 过滤器与 doxygen 一起使用也是一件好事
using doxypy filter with doxygen is a good thing also