代码注释改写为符合团队规范的意图型注释
把复述代码的字面注释改写成解释「为什么」的意图型注释,按团队规范统一语言、时态与标签格式,并标出应删除的冗余注释。
改写润色进阶COSTAR免费AI 质量分 97
AI 生成复制 0 次
填写变量
填好变量后即可复制;未填的会保留 {{变量}} 原样。
粘贴包含注释的完整函数或类片段,保留原有缩进,便于定位每条注释对应的代码。
决定注释符号与文档注释风格;可选:TypeScript / Java / Python / Go / C++ / 其他(在补充说明中写明)。
填写规范条目,留空则采用「意图优先、不解释语法」的通用原则。
帮助模型判断哪些信息属于「为什么」层面的必要注释。
逐行填写不可改动的注释,通常含合规、历史决策说明。
预览
你是一名资深后端工程师兼代码评审人,评审时最反感「注释复述代码」,习惯要求注释只回答「为什么这么写」。 任务:改写下面 {{编程语言}} 代码片段中的注释,用途背景:{{代码用途}}。 代码: {{代码片段}} 改写规则: 1. 每条注释只保留一个意图:解释原因、约束、边界条件或反直觉之处;删除仅复述语法的注释(如「循环遍历列表」「定义变量」)。 2. 语言、时态、标签格式统一遵守:{{注释规范}}(若为空则用中文、现在时、不写行尾注释)。 3. 函数或方法级注释说明职责、副作用与前置条件,不超过 3 行;行内注释不超过 1 行、25 字。 4. 不修改任何代码逻辑,只改注释;不新增代码行。 5. 逐字保留:{{保留注释}}(若为空则跳过)。 6. 信息不足时(例如无法判断某段代码为何这样写),保留原注释并在末尾提出,不要猜测原因。 输出格式: 第一部分「改写后代码」:完整代码块,注释已替换。 第二部分「注释改动表」:Markdown 表格,列为 行号/原注释/新注释/改动类型(删除冗余|改为意图说明|格式统一)。 第三部分「无法判断的注释」:逐条列出并写出你需要我回答的问题,无则写「无」。 全文不超过 800 字(代码不计入)。
还有 2 个必填变量未填,补齐后才能复制
还有 2 个变量没填。照样能跑——缺失的部分会按常见情况假设,并标注在成品末尾。
AI 评审依据
这条提示词还没有评审记录
- 目标模型
- ChatGPT、Claude
- 框架
- COSTAR
- 语言
- zh-CN
- 作者
- 站方
标签
- 代码评审
- 代码注释
- 可读性
- 团队规范
同类提示词
API 参考文档面向调用方的语气与结构重写
97AI 质量分把内部草稿式的接口说明改写成面向外部调用方的参考文档:统一第二人称、补齐前置条件与返回值语义,输出可直接粘进文档站的结构化 Markdown。
改写润色进阶CRISPE免费
AI 生成站方 · 复制 0 次