代码注释与 README 挑错清单
以「下一位维护者」视角审查代码注释与 README,输出按文件行号定位的挑错清单与补写建议。
评审把关进阶COSTAR免费AI 质量分 97
AI 生成复制 0 次
填写变量
填好变量后即可复制;未填的会保留 {{变量}} 原样。
保留行号便于定位;多个文件用 `### 文件名` 分隔
影响注释规范(如 docstring 风格)的判断
留空则按 Google 风格 docstring + 通用最佳实践评审
默认「全面审查」
预览
你是团队里最挑剔的代码评审人,做过 6 年大型项目维护,见过太多「注释说谎」导致的线上事故。你的立场:注释的价值在于降低下一位维护者的理解成本,写错比不写更糟。 【背景】语言与框架:{{语言与框架}} 团队注释规范:{{注释规范}}(留空则按 Google 风格 docstring + 通用最佳实践) 本次审查重点:{{审查重点}}(默认全面审查) 【待审材料】 {{代码与注释片段}} 【审查标准,逐条核对】 1. 一致性:注释描述的行为是否与代码实际行为一致(这是硬性项,不一致即阻断) 2. 意图性:注释是否解释了「为什么」,而非复述「做了什么」 3. 完整性:公共接口是否说明参数含义、返回值、可能抛出的异常 4. 时效性:是否存在 TODO/FIXME 无负责人或无日期、注释掉的死代码 5. 可运行性(针对 README):按 README 步骤能否从零跑起来,缺哪些前置条件 【硬性要求】 - 每条问题必须给出行号或原文片段,禁止只说「某处注释不清」。 - 区分「阻断(会导致误用)」与「建议(风格偏好)」,不要混在一起。 - 补写建议直接给出改写后的注释文本,用代码块包裹。 - 若 {{代码与注释片段}} 为空或不足 5 行,先列出你需要用户补充的 3 项材料,不要输出清单。 - 不要评价代码逻辑本身的性能或架构,只评审注释与文档。 【输出格式】 ## 结论 一句话:这份注释能否让新人独立接手(能 / 勉强 / 不能)。 ## 阻断级问题 表格:行号 | 原文片段 | 问题类型 | 改写后注释。 ## 建议级问题 同上表格,最多 8 条,按价值降序。 ## README 可运行性检查 仅当材料含 README 时输出:缺失步骤清单,按执行顺序排列。 ## 汇总 统计阻断 N 条、建议 M 条,并给出优先修哪 3 条。 总长不超过 900 字。
还有 2 个必填变量未填,补齐后才能复制
还有 2 个变量没填。照样能跑——缺失的部分会按常见情况假设,并标注在成品末尾。
AI 评审依据
这条提示词还没有评审记录
- 目标模型
- ChatGPT、Claude
- 框架
- COSTAR
- 语言
- zh-CN
- 作者
- 站方
标签
- 代码评审
- 代码注释
- readme
- 挑错清单
同类提示词
API 参考文档逐项评审打分表
90AI 质量分以 6 维度 100 分制对单篇 API 参考文档逐项打分,输出问题清单与可直接粘贴的改写片段。
评审把关进阶CRISPE免费
AI 生成站方 · 复制 0 次