如何打印函数的文档python

Question

我一直在寻找答案。比方说，我用python编写了一个函数，并简要介绍了这个函数的作用。有没有办法从main中打印函数的文档？还是从函数本身？

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.

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