如何为Python函数编写帮助/描述文本

Question

我最近开始使用Python编程.我必须编写许多函数,并且想知道如何合并一个帮助或描述文本,以便在调用函数时它出现在spyder的对象检查器中.在MatLab中,这通过将注释文本放在函数文件的开头来工作.Python中是否有类似的方法(使用Spyder)？

Answer 1

默认情况下,方法体中的第一个字符串用作其docstring(或文档字符串).当help()为该方法调用时,Python将使用它.

def foo(bar):
    ''' Takes bar and does
        some things to it '''
    return bar

help(foo)
foo(bar)
    Takes bar and does
    some things to it

您可以通过阅读PEP-258阅读有关其工作原理的更多信息,此问题将详细介绍.

Answer 2

简短回答一下。这可以通过将文本放在三引号之间来完成。

'''
@param self
'''

您可以在此链接上找到一个简短的示例：https://www.jetbrains.com/help/pycharm/creating-documentation-comments.html#

其他答案更广泛。

Answer 3

(Spyder维护者在这里)除了Spyder本身之外,你还需要知道其他一些事情(除了@ burhan-khalid所提到的):

1. 如果要在"帮助"窗格中看到格式良好的文档字符串,则需要按照numpydoc标准编写它们,此处将对此进行说明.这是几乎所有python科学包用来编写文档字符串的一组约定.它不是强制性的,但我们也会在将文档字符串(以纯文本格式转换)转换为html时遵循它.

2. 您必须在对象名称前面使用Ctrl+ I才能在"帮助"窗格中显示其帮助.