Django是否有一个Javadoc等价物？

Question

我希望能够在编写代码时对代码进行注释，然后让文档生成器生成类似于Javadoc的东西，希望按类型排序（视图vs模型等等）。在

Answer 1

Sphinx对于最终用户文档非常有用。然而，docstring也有一个完整的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是为REST框架设计的，因此它可能只适用于使用django-rest-framework的情况。在