Dsh Code Review

审查代码改动时使用:按六维清单检查,输出结构化审查报告。

hackerFish 2b89fab 1.1 KB Updated

File contents

结构化代码审查

六维检查(按优先级)

  1. 正确性:逻辑是否实现意图;边界条件(空、单元素、超长、负数、并发)是否处理
  2. 安全:外部输入是否校验/转义;密钥是否泄漏;命令注入、路径穿越是否存在
  3. 可维护性:命名是否表达意图;函数是否单一职责;重复代码是否应提取
  4. 错误处理:失败路径是否可观测;错误信息是否可定位
  5. 测试:关键路径是否有测试;测试是否测了行为而不是实现细节
  6. 文档:接口变化是否同步文档与版本号

审查报告格式

文件:行号 | 严重级(阻断/建议/吹毛求疵) | 事实 | 建议
  • 先列阻断项,再列建议项;吹毛求疵的合并成一条
  • 只批评可复现的事实,不评价作者
  • 拿不准的标注"需讨论",不要用"显然""一定"下判断

自查用法

把上面的清单当成自己的代码出门前检查:提交 PR 前先以审查者视角过一遍。

hackerFish/awesome-dsh-skills/tree/main/skills/dsh-code-review commit 2b89fab786

Frequently asked questions

npx skillmds@latest add hackerfish/dsh-code-review