Python函数注释备注的写法和使用方法

def add(a, b):
    """计算两个数的和"""
    return a + b

# 查看函数备注的方法
print(add.__doc__)  # 输出：计算两个数的和
help(add)  # 更友好的交互式查看，会显示函数签名+备注

def calculate_area(shape: str, width: float, height: float = None) -> float:
    """
    计算常见几何图形的面积。

    支持的图形：矩形（rectangle）、三角形（triangle）
    
    Args:
        shape: 图形类型，可选值为 "rectangle" 或 "triangle"
        width: 宽度/底边长（浮点型）
        height: 高度（浮点型），矩形可不传（默认等于width，即正方形）
    
    Returns:
        计算出的面积（浮点型）
    
    Raises:
        ValueError: 当shape不是指定值，或宽/高为负数时抛出
    """
    if width < 0 or (height and height < 0):
        raise ValueError("宽/高不能为负数")
    
    if shape == "rectangle":
        height = height or width  # 未传height时默认正方形
        return width * height
    elif shape == "triangle":
        if not height:
            raise ValueError("三角形必须传入height")
        return 0.5 * width * height
    else:
        raise ValueError(f"不支持的图形类型：{shape}")

# 查看备注
help(calculate_area)

def calculate_area(shape: str, width: float, height: float = None) -> float:
    """
    计算常见几何图形的面积。

    :param shape: 图形类型，可选值为 "rectangle" 或 "triangle"
    :type shape: str
    :param width: 宽度/底边长（浮点型）
    :type width: float
    :param height: 高度（浮点型），矩形可不传（默认等于width）
    :type height: float
    :return: 计算出的面积
    :rtype: float
    :raises ValueError: 当shape非法或宽/高为负时抛出
    """
    # 逻辑和上面一致（省略）
    pass