从函数获取文档字符串

Question

我有以下功能：

def my_func():

    """My docstring is both funny and informative"""

    pass

如何访问文档字符串？

Answer 1

可以交互地显示help(my_func)或者从代码中，您可以使用my_func.__doc__

Answer 2

您也可以使用inspect.getdoc。它__doc__通过将制表符标准化为空格并向左移动文档主体以删除常见的前导空格来清理。

Answer 3

在ipython或jupyter笔记本上，您可以使用上述所有方法，但我同意my_func?要么?my_func快速概述方法签名和文档字符串。我避免使用my_func??（如@rohan所评论）以docstring，仅用于检查源代码