代码文档生成

为代码生成文档和注释

提示词

请为以下代码生成完整文档:

`
[粘贴代码]
`

要求:
1. 函数/类的JSDoc/Pydoc/文档字符串
2. 参数说明(类型、含义、约束)
3. 返回值说明
4. 异常说明
5. 使用示例(2-3个)
6. 注意事项
7. README段落(整体说明)

示例输出

def calculate_bmi(weight: float, height: float) -> float:
    """
    计算BMI(身体质量指数)。

    Args:
        weight: 体重,单位千克(kg),必须大于0
        height: 身高,单位米(m),必须大于0

    Returns:
        BMI值,保留1位小数

    Raises:
        ValueError: 当weight或height小于等于0时抛出

    Examples:
        >>> calculate_bmi(70, 1.75)
        22.9
        >>> calculate_bmi(50, 1.6)
        19.5

    Note:
        BMI = 体重(kg) / 身高(m)²
        中国标准:<18.5偏瘦,18.5-23.9正常,≥24超重
    """
    if weight <= 0 or height <= 0:
        raise ValueError("体重和身高必须大于0")
    return round(weight / (height ** 2), 1)
0

评论 0

更多

登录后可点赞、收藏、评论和举报。

还没有评论,先发起一个具体问题。