我希望能够在我去的时候对代码进行评论然后让文档生成器生成类似于希望按类型排序的
Javadoc(视图与模型等). 最佳答案 Sphinx适用于最终用户文档.但是,对于文档字符串也有完整的PEP标准.这是一篇关于内联文档之美的古老而精彩的文章,它是
Python的标准：

http://www.electricmonk.nl/log/2008/06/22/why-python-rocks-i-inline-documentation/

Docstrings可以为您的开发和系统团队带来很长的路要走,但请务必查看Sphinx(和https://readthedocs.org)以获取更多信息.祝好运！