python - 如何打印函数的文档 python

Question

<分区>

Answer 1

您可以使用 help() 或打印 __doc__。 help() 打印对象的更详细描述，而 __doc__ 保存仅 您用三重引号定义的文档字符串 """""" 在函数的开头。

例如，在 sum 内置函数上显式使用 __doc__:

print(sum.__doc__)
Return the sum of a 'start' value (default: 0) plus an iterable of numbers

When the iterable is empty, return the start value.
This function is intended specifically for use with numeric values and may
reject non-numeric types.

此外，由于 Python 首先编译一个对象并在执行期间评估它，您可以在函数内调用 __doc__ 没有问题:

def foo():
    """sample doc"""
    print(foo.__doc__)

foo()  # prints sample doc

请记住，除了函数之外，模块和类还有一个 __doc__ 属性来保存它们的文档。

或者，使用help() 求sum:

help(sum)

将打印:

Help on built-in function sum in module builtins:

sum(iterable, start=0, /)
    Return the sum of a 'start' value (default: 0) plus an iterable of numbers

    When the iterable is empty, return the start value.
    This function is intended specifically for use with numeric values and may
    reject non-numeric types.

提供更多信息，包括文档字符串。