Python函数的说明文档

函数的说明文档
函数是纯代码，可以给函数添加说明文档，辅助理解函数作用

定义语法

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

# 定义函数，进行文档说明
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(5, 8)