获取函数的文档字符串

Question

我有一个这样的函数：

def my_func():
    """My docstring is both funny and informative"""
    pass

我该如何访问这个函数的文档字符串呢？

Answer 1

在ipython或jupyter notebook中，你可以使用上面提到的所有方法，但我更喜欢使用

my_func?

或者

?my_func

来快速查看方法的签名和文档说明。

我不太喜欢使用

my_func??

（正如@rohan所说）来查看文档说明，而是只用它来检查源代码。

Answer 2

你还可以使用 inspect.getdoc 这个功能。它的作用是整理文档字符串（也就是代码里的说明文字），把制表符（Tab）转换成空格，并且把文档内容往左移动，去掉那些常见的前导空格。

Answer 3

你可以通过交互的方式来显示它，使用下面的代码：

help(my_func)

或者如果你是在代码中想要获取它，可以用这个方法（记得用print(.)把它包起来，这样可以得到格式化的输出）：

my_func.__doc__