是否有Django的Javadoc等价物？

Question

我希望能够在我去的时候对代码进行评论然后让文档生成器生成类似于希望按类型排序的Javadoc（视图与模型等）。

Answer 1

Sphinx适合最终用户文档。但是，对于文档字符串也有完整的PEP标准。这是一篇关于内联文档之美的古老而精彩的文章，它是Python中的标准：

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

Docstrings可以为您的开发和系统团队带来很长的路要走，但请务必查看Sphinx（和https://readthedocs.org）了解更多信息。祝你好运！

Answer 2

如果您正在寻找api django文档，我们会使用django REST swagger我工作的地方，它会尽可能为您的api和模型生成一个swagger文档。它还将读取格式化的注释以更好地记录文档。 Django REST swagger是为其余框架设计的，所以如果你使用django-rest-framework，它可能只适合你。