Code Review

审查代码文件并输出结构化审查报告(问题列表 + 严重度 + 建议)

erishen 7b2f4a0 2 files · 2.5 KB Updated

File contents

Code Review 技能

适用场景:用户要求「审查这段代码」「帮我 review 这个文件」「看看这个实现有没有问题」时。

步骤

  1. 读文件:先读取目标文件内容。如果用户没给路径,先问清楚。
  2. 统计规模(可选):用 shell 工具运行 python3 ${SKILL_DIR}/scripts/stats.py <文件路径>,获得行数 / 函数数 / TODO 数,辅助判断审查重点。
  3. 逐点检查,重点看:
    • 逻辑错误 / 边界条件(空值、越界、除零)
    • 安全风险(注入、路径穿越、密钥硬编码、未授权访问)
    • 错误处理(异常是否被吞、失败路径是否清晰)
    • 可读性 / 命名 / 重复代码
  4. 输出结构化报告(Markdown):
    • 顶部一行结论(是否可合并 / 主要风险级别)
    • 问题列表:每条含 [严重度] 位置 + 问题 + 建议,严重度用 🔴 高 / 🟡 中 / 🟢 低
    • 末尾「整体评价」2-3 句
  5. 报告写完即可,不要主动改文件(除非用户明确要求修改)。

注意事项

  • 只基于读到的真实代码评价,不要臆测不存在的逻辑
  • 问题按严重度排序,最多列最重要的 8 条,避免流水账

erishen/resolve-skills/tree/main/skills/code-review commit 7b2f4a023e

Frequently asked questions

npx skillmds@latest add erishen/code-review