代码注释与实现一致性审计
面向一线开发者,把一段代码与其注释/文档字符串对照审计,找出注释说谎、注释缺失、注释冗余三类问题,并给出可直接替换的注释文本。
分析诊断进阶COSTAR免费AI 质量分 97
AI 生成复制 0 次
填写变量
填好变量后即可复制;未填的会保留 {{变量}} 原样。
保留原有注释和缩进;建议 30–200 行。超过 300 行请先截取一个文件。
可选:Java / Go / Python / TypeScript / C++ / 其他(在代码开头注明)。
留空则按通用工程惯例判断,并在输出中声明。
可选:注释与实现是否一致 / 注释是否足够完整 / 注释是否冗余 / 三者均衡。默认均衡。
预览
背景:你是团队里的代码评审负责人,长期处理「注释写着 A、代码做的是 B」这类隐性缺陷,判断依据必须落在代码行上。 角色:以代码审计员身份工作,只审计注释与文档字符串,不改动业务逻辑。 任务:审计以下 {{编程语言}} 代码中的注释质量,审计重点为「{{审计重点}}」。 【团队注释规范】(可能为空) {{注释规范}} 【待审计代码】 {{代码片段}} 审计三类问题: - 说谎:注释描述与代码实际行为不符(含单位、边界、异常、副作用)。 - 缺失:公开接口、非直观分支、魔法数字、并发/事务语义缺少说明。 - 冗余:注释只是复述代码字面含义,或与代码同时改动后已无信息量。 输出格式(严格按此结构): ### 1. 审计摘要 一段话,不超过 120 字:共发现几处说谎、几处缺失、几处冗余,最危险的一处是什么。 ### 2. 问题明细 按「说谎 → 缺失 → 冗余」顺序输出,每条格式固定为: - 类型: - 位置:函数名 + 行号或可定位的代码片段 - 现有注释:(无则写「无」) - 代码实际行为: - 风险:会导致什么误用或排障困难 - 建议注释:给出可直接替换的完整注释文本,语言与代码一致 ### 3. 判断依据说明 用 3 条以内说明你在判定「说谎」时依据了哪些代码细节(例如单位换算、空值分支、异常抛出)。 ### 4. 无法判断项 列出需要作者确认才能定性的点。 约束: - 硬性:不得修改代码逻辑,只产出注释文本。 - 硬性:「建议注释」必须与代码实际行为一致,不得美化未实现的意图。 - 硬性:每条问题必须能定位到具体函数或行。 - 偏好:优先报会导致线上事故或误用的说谎类问题。 - 若 {{代码片段}} 为空或无法识别为代码,先列出你需要用户补充的三件事,不要臆测。 - 若 {{注释规范}} 为空,在摘要末尾注明「按通用工程惯例判断,未使用团队规范」。
还有 3 个必填变量未填,补齐后才能复制
还有 3 个变量没填。照样能跑——缺失的部分会按常见情况假设,并标注在成品末尾。
AI 评审依据
这条提示词还没有评审记录
- 目标模型
- ChatGPT、Claude
- 框架
- COSTAR
- 语言
- zh-CN
- 作者
- 站方
标签
- 代码评审
- 代码注释
- 一致性审计
- 技术债
同类提示词
API 文档可读性诊断与风险清单
97AI 质量分面向后端/平台工程师,对一份 API 文档做可读性与完整性诊断,输出问题清单、成因、风险等级与判断依据,并给出最小改动建议。
分析诊断进阶CRISPE免费
AI 生成站方 · 复制 0 次