13、函数的说明文档(了解即可)

目录

①前面所学的为代码语言，要一行一行去理解太费时间还复杂。所以呢，就有了这个函数说明文档。

②函数的说明文档在函数体的上面，使用三引号("""""")的形式，对函数进行解释说明：

---

①前面所学的为代码语言，要一行一行去理解太费时间还复杂。所以呢，就有了这个函数说明文档。

②函数的说明文档在函数体的上面，使用三引号("""""")的形式，对函数进行解释说明：

先定一个函数，然后进行文档说明：

def add(x, y):
    """打三个引号然后回车，自动补全文档。
    add函数可以接收2个参数，进行2数相加的功能。
    :param x:形参x表示相加的其中一个数字
    :param y:形参y表示相加的另个数字
    :return:返回值是2数相加的结果
    """
    result = x + y
    print(f'2数相加的结果为：{result}')
    return result

add(1, 5)  # 将鼠标指针停在调用函数或传参上，会看到注释

———————————————————结束———————————————————