python - 如何为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会涉及更多细节。