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

Question

我最近开始使用Python编程。我需要编写许多函数，想知道如何加入帮助或描述文本，以使其在调用函数时出现在Spyder的对象检查器中。 在MatLab中，这可以通过在函数文件开头放置注释文本来实现。在Python中是否有类似的方法（使用Spyder）？

- user1984653

Answer 1

默认情况下，方法主体中的第一个字符串被用作其docstring（或文档字符串）。Python在调用该方法的help()时会使用它。

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了解更多信息，而这个问题则更详细地讨论了一些细节。

- Burhan Khalid

---

如何为软件包做到这一点？ - Adesh Atole

Answer 2

(Spyder的维护人员在这里) 除了@burhan-khalid提到的内容外，还有另外一些关于Spyder本身需要知道的事情：

1. 如果您想在Help窗格中看到漂亮格式化的docstrings，请按照此处所述的numpydoc标准编写它们。这是几乎所有python科学包用于编写docstring的约定。这不是强制性的，但我们在将docstring（以纯文本形式呈现）转换为html时也遵循该标准。

2. 您必须在对象名称前使用Ctrl+I来查看其帮助信息。

- Carlos Cordoba

---

我发现这非常有帮助，谢谢！这是新的位置吗？https://numpydoc.readthedocs.io/en/latest/format.html#docstring-standard - uhoh

Answer 3

简短回答：可以使用三重引号将文本放置其中来完成此操作。

'''
@param self
'''

你可以在这个链接上找到一个简短的示例：https://www.jetbrains.com/help/pycharm/creating-documentation-comments.html# 其他答案更加详细。

- Gerardsson