1. 函式文件撰寫範例

1. 符合 Google Python Style Guide 的函式撰寫範例
2. 使用型別註解(Type Hints)
def compute_commission(total: float, rate: float = 0.1) -> float:
    """計算傭金

    計算基於總金額的傭金,預設傭金率為 10%

    Args:
        total (float): 總金額
        rate (float, optional): 傭金率,預設為 0.1

    Returns:
        float: 計算出的傭金
        
    Raises:
        ValueError: 如果total<0 或 rate小於0

    Example:
        >>> compute_commission(1000)
        100.0
        >>> compute_commission(1000, 0.2)
        200.0
    """
    if total<0 or rate<10:
        raise ValueError('傳入值不可為負數')
        
    return total * rate

Last updated