代码注释怎么写才规范
写完代码不知道注释加在哪、写什么，团队一看没注释就骂，自己过俩月也看不懂当初为啥这么写。
有人这样说「刚写完一个Python函数，领导说没注释就别交了，我真不会写啊。」
能替你选的都选好了。不想动，直接点下面「交给 AI 办」，点一下就开始做；想改，就点一下要的那个。
已替你选好想改就点一下
只有你知道的不填就先空着，成品里留【待填】
还想怎么改可以不选
高级选项一般不用动 · 这件事通常 1 分钟左右做好
示例成品全文按上面这组示例选项真跑出来的
【代码注释规范】
- 文件头注释：说明模块用途、作者、创建日期。
- 函数注释：用文档字符串写清参数含义、返回值、可能抛出的异常。
- 关键逻辑处加行内注释，只解释「为什么这么做」，不要复述「代码在干什么」。
【示例（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 都能一眼看懂接口，行内注释解释了为何提前校验。整体遵循「注释解释意图、代码表达实现」的原则，别写没有信息量的废话注释。