示例成品 · 平台演示,按左边这组点选真跑出来的
【代码注释规范】
1. 文件头注释:说明模块用途、作者、创建日期。
2. 函数注释:用文档字符串写清参数含义、返回值、可能抛出的异常。
3. 关键逻辑处加行内注释,只解释「为什么这么做」,不要复述「代码在干什么」。
【示例(Python 函数)】
```python
def parse_order(raw: str) -> dict:
"""解析原始订单字符串为结构化字典。
Args:
raw: 逗号分隔的订单文本,如 "1001,苹果,3"。
Returns:
含 order_id、name、qty 三个键的字典。
Raises:
ValueError: 当字段数量不足三个时抛出。
"""
parts = raw.split(",")
if len(parts) < 3: # 字段不足提前报错,避免脏数据流入下游
raise ValueError("订单字段不完整")
return {"order_id": parts[0], "name": parts[1], "qty": int(parts[2])}
```
【说明】文档字符串让同事和 IDE 都能一眼看懂接口,行内注释解释了为何提前校验。整体遵循「注释解释意图、代码表达实现」的原则,别写没有信息量的废话注释。
点左边「开工 · 直接出成品」,出一份你自己的版本(文字免费)