如何为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详细了解其工作原理，this question了解更多详情。

Answer 2

（ Spyder维护者）除了Spyder本身之外，你还需要了解其他一些事情（除了@ burhan-khalid所提到的）：

1. 如果您希望在“帮助”面板中看到格式良好的文档字符串，则需要按照numpydoc标准编写它们，标准为here。这是几乎所有python科学包用来编写文档字符串的一组约定。这不是强制性的，但我们也会在将文档字符串（以纯文本格式转换）转换为html时遵循它。

2. 您必须在对象名称前使用 Ctrl + I ，才能在我们的帮助面板中显示他们的帮助。

Answer 3

简而言之。可以通过将文本放在三引号之间来实现。

'''
@param self
'''

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

其他答案更广泛。