【python】函数说明文档

目录

• 函数介绍
• 函数的定义
• 函数的参数
• 函数的返回值
• 函数说明文档
• 函数的嵌套调用
• 变量的作用域
• 综合案例

学习目标

1. 掌握通过注释对函数进行解释说明

函数的说明文档

函数是纯代码语言，想要理解其含义，就需要一行行的去阅读理解代码，效率比较低。

我们可以给函数添加说明文档，辅助理解函数的作用。
语法如下：

def func(x, y):
    """
    函数说明：
    :param x: 形参x的说明
    :param y: 形参y的说明
    :return: 返回值的说明
    """
    函数体
    return 返回值

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

• 内容应写在函数体之前

在 PyCharm/VSCode 中查看函数说明文档

在 PyCharm/VSCode 编写代码时，可以通过鼠标悬停，查看调用函数的说明文档

总结：

1. 函数说明文档的作用是？

对函数进行说明解释，帮助更好理解函数的功能

2. 定义语法

def func(x, y):
    """
    函数说明：
    :param x: 形参x的说明
    :param y: 形参y的说明
    :return: 返回值的说明
    """
    函数体
    return 返回值

• :param 用于解释参数
• :return 用于解释返回值