Question

在PHP中，我习惯了PHPdoc语法：

/** Do something useful
@param first    Primary data
@return int
@throws BadException
*/
function($first){ ...

- 有点简短有用的参考：当您需要的只是回忆'那是什么??'时非常方便，特别是对于第三方库。此外，所有IDE都可以在弹出提示中显示它。

似乎Python中没有约定：只是纯文本。它很好地描述了事情，但它太长了，不能成为一个摘要。

好的，就这样吧。但在我的应用程序中，我不想使用成堆的明文。

是否有任何众所周知的惯例？以及如何记录类属性？！ PyCharm IDE食谱特别受欢迎：）

在Python3中，功能注释有PEP 3107。这对2.x（2.6，特别是）

没有用

还有一个PEP 0287用于reStructuredText：花哨但仍然没有结构化。

Answer 1

我使用epydoc。它支持reStructured Text中的注释，并从这些注释生成HTML文档（类似于javadoc）。

Answer 2

基于reStructuredText（这是python生态系统中的标准），numpydoc标准是明确定义的，并且具有Sphinx集成。为PyCharm编写一个可以消化numpydoc的插件应该是相对简单的。