python函数注释规范

Python 函数注释的规范是使用 docstring 来编写函数的文档字符串。docstring 是函数的第一个语句，用于描述函数的作用、参数、返回值等信息。

以下是 Python 函数注释的规范：

1. 在函数定义的下一行，用三个双引号或三个单引号开始 docstring。
2. 第一行是函数的简要描述。
3. 如果函数有参数，用 Args: 开始一段参数列表。
4. 参数列表中每行包含参数名和参数描述，用冒号隔开。
5. 如果函数有返回值，用 Returns: 开始一段返回值描述。
6. 返回值描述中包含返回值类型和返回值意义。
7. 如果函数有异常，用 Raises: 开始一段异常描述。
8. 异常描述中包含异常类型和异常触发条件。

例如，以下是一个简单的 Python 函数注释示例：

def add(x, y):
    """
    计算两个数的和。

    Args:
        x (int): 第一个加数。
        y (int): 第二个加数。

    Returns:
        int: 两个数的和。

    Raises:
        TypeError: 如果参数不是整数。
    """
    if not isinstance(x, int) or not isinstance(y, int):
        raise TypeError("参数必须是整数")
    return x + y

注释中描述了函数的作用、参数、返回值和可能的异常，可以方便其他开发者理解和使用该函数。