python 函数注释格式

def function_name(param1, param2, ...):
    """
    这里是对函数的简要描述。

    参数:
    param1 (type): 参数1的描述。
    param2 (type): 参数2的描述。
    ...

    返回:
    type: 返回值的描述。

    异常:
    ExceptionType: 可能抛出的异常及其描述。

    示例:
    >>> function_name(value1, value2)
    example_output
    """
    # 函数体

def calculate_area(length, width):
    """
    计算矩形的面积。

    参数:
    length (float): 矩形的长度。
    width (float): 矩形的宽度。

    返回:
    float: 矩形的面积。

    异常:
    ValueError: 如果长度或宽度为负数。

    示例:
    >>> calculate_area(10, 5)
    50.0
    """
    if length < 0 or width < 0:
        raise ValueError("长度和宽度必须为非负数")
    return length * width