记录python代码的最佳方法

Question

我开始研究python33模块的文档。但我是这个领域的初学者。 如果你能帮我选择好的工具，我将非常感激。 我在互联网上阅读了很多主题。我认为最受欢迎的是狮身人面像和Epydoc。但是哪一个更好用呢？互联网上讨论的几乎所有问题都很陈旧。我确信自2011年以来情况发生了变化。可能有人在为python docs做文档。请帮助我们迈出第一步。

Answer 1

无法想象除了以下更有用和有用的材料：

• PEP8 Comments section
• PEP8 Documentation Strings section
• Documentation The Hitchhiker’s Guide to Python
的帖子

而且，是的：

  

Epydoc已停止使用。请改用Sphinx。

希望有所帮助。