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

Question

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

Answer 1

默认情况下，方法主体中的第一个字符串用作其文档字符串（或文档字符串）。当为该方法调用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

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

'''
@param self
'''

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

其他答案更广泛。

Answer 3

（这里是 Spyder 维护者）关于 Spyder 本身，您还需要了解其他几件事（除了 @burhan-khalid 提到的）：

1234563这是几乎所有 python 科学包用于编写其文档字符串的一组约定。这不是强制性的，但我们在将文档字符串（以纯文本形式出现）转换为 html 时也遵循它。

1. 您必须在对象名称前使用 Ctrl+I 才能在我们的帮助窗格中显示其帮助。