10 python函数（下）

一、函数的说明文档

函数是纯代码语言，如果需要一行行去阅读才能理解它的意思，就没有效率，我们编写函数是为了提高效率，只要知道怎么使用就可以了，那就需要有文档进行说明。
我们在函数上面停留一会，就会显示该函数的说明文档，比如print函数，下面就是print的说明文档。

说明文档的定义

通过多行注释的形式，对函数进行说明

要形成说明文档，必须放在函数体之前。

def 函数名(参数列表):
    """
    函数说明
    :param 参数列表:
    :return:
    """
    函数体
    return 函数返回值

def add(x, y):
    """
    求 x 和 y 的和
    :param x: 参数x的说明
    :param y: 参数y的说明
    :return: 返回值的说明 返回和
    """
    return x + y

print(add(1, 2))