记录我的Django鳕鱼

Question

我刚用Django开始了一个项目，我想为一个Python函数编写类似下面的javadoc片段。我见过我可以使用Sphinx或RestructedText，但这似乎有点过头了。在Python中通常的方法是什么？在

我的目标不是用我的文档生成一个大的pdf/html，而是让我的IDE（pyCharm）在我调用我的方法时显示文档。在

 /**
  * 
  * @param p1
  * @param p2
  * @param p3
  * @return ...
  */

Answer 1

如PyCharm webhelp on supported docstring formats中所述，您将有三个选项：

• RestructuredText (rst) for docutils。您不必使用Sphinx生成HTML。你可以让它尽可能轻。在
• epytext格式。（另请参见：epydoc fields documentation）
• 纯文本。这在参数或返回值钩子方面没有提供任何内容。PyCharm只显示普通docstring。在