结构化的python文档字符串,对IDE友好

在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)没有用

还为reStructuredText提供了PEP 0287：花哨的但仍未结构化.

解决方法:

numpydoc标准是基于reStructuredText(在python生态系统中为标准)定义的,并且具有Sphinx集成.为PyCharm编写一个可以消化numpydoc的插件应该相对简单.

Sphinx还提供有关如何记录属性的参考：http://sphinx.pocoo.org/ext/autodoc.html?highlight=autoattribute

标签：python-2-x,docstring,python
来源： https://codeday.me/bug/20191208/2094714.html