python - 记录python代码的最佳方式

Question

我开始研究 python33 模块的文档。但我是这个领域的初学者。如果您能帮我选择好的仪器来做这件事，我将不胜感激。我在互联网上阅读了很多主题。我发现最受欢迎的是 sphinx 和 Epydoc。但是它们中的哪一个更好用？互联网上讨论的几乎所有问题都是相当古老的。我敢肯定，自 2011 年以来情况已经发生了变化。可能有人在为 python 文档做文档方面是专业的。请帮助迈出第一步。

Answer 1

无法想象更多有用和有用的材料，除了：

• PEP8 评论部分
• PEP8 文档字符串部分
• The Hitchhiker's Guide to Python 的文档主题

是的：

Epydoc 已停产。改用狮身人面像。

希望有帮助。