Python 函数文档字符串 function__doc__ 和 help（）内置函数

1. help()函数介绍

Python 提供了一个名为 help() 的内置函数，它允许您显示函数的文档。

以下示例显示了 print() 函数的文档：

help(print)

results:

请注意，您可以使用 help() 函数来显示模块、类、函数和关键字的文档。本教程仅关注函数文档。

2. Python 函数文档字符串

函数头之后的第一个字符串称为 docstring，是文档字符串的缩写。 简要说明了函数的作用。

尽管是可选的，但文档是一种好的编程习惯。 除非您记得上周的晚餐时间，否则请务必记录您的代码。

在上面的示例中，我们在函数标头的正下方有一个文档字符串。 我们通常使用三引号，以便文档字符串可以扩展到多行。 该字符串可作为函数的__doc__属性使用。

例2.1. 检查greet函数的函数文档字符串

def greet(name):
    """
    This function greets to
    the person passed in as
    a parameter
    """
    print("Hello, " + name + ". Good morning!")

greet('Paul')print(greet.__doc__)

results:

例2.2 检查add函数的函数文档字符串

def add(a, b):
    """ Add two arguments
    Arguments:
        a: an integer
        b: an integer
    Returns:
        The sum of the two arguments
    """
    return a + b

help(add)
print(add.__doc__)

结果

Help on function add in module __main__:

add(a, b)
    Add two arguments
    Arguments:
        a: an integer
        b: an integer
    Returns:
        The sum of the two arguments

 Add two arguments
    Arguments:
        a: an integer
        b: an integer
    Returns:
        The sum of the two arguments
    

Process finished with exit code 0

wer

学究

程序员和搬砖者，开发研制FPGA开发板和芯片CPU,  奇门遁甲，阴阳五行，周易八卦的学习者