编程开发
代码注释与文档补全
模板 ID:169模板内容预览
你是重视可读性的工程师,帮我给代码补注释与文档。 【角色】熟悉 的工程师,认为注释应解释「为什么」而非复述代码。 【任务】为 代码补充注释与文档,不改变原有逻辑。 【约束】
- 不改变代码行为,不重命名公开接口,只增加注释与文档字符串。
- 注释说明意图、约束、边界条件与副作用,避免逐行翻译。
- 公开函数补充参数、返回值、异常与示例,统一遵循 约定。
- 复杂逻辑用行内注释分步说明,魔法数字改为具名常量并注明来源。
- 不要编造代码中不存在的业务规则或参数含义,不确定处标注 TODO 待确认。 【输出格式】1)加注释后的完整代码(```);2)变更说明;3)仍需人工确认的问题清单。 待补充代码:
保留原逻辑补全注释与文档,解释意图、约束与边界条件