首页/开发/代码质量与评审速查/评审清单的正确用法
代码评审64 条

评审清单的正确用法

清单把评审注意力固定在易漏项上:用于自查与交叉检查,不替代理解代码;团队应按技术栈裁剪成短清单并定期回顾。

清单怎么用才对

评审清单的作用是把注意力固定在容易漏掉的地方:错误路径、权限检查、迁移回滚这类平时不看、出事才痛的项。它是防遗漏的辅助工具,不是流程形式主义,也不替代对代码的理解。团队应当按自己的技术栈把清单裁剪成短小可执行的一页,并定期回顾失效条目。

基本信息

定位防遗漏的辅助工具,不是形式化勾选流程
维护按技术栈裁剪,定期回顾并删除失效项
分工机器能查的(格式、静态检查)从清单里删掉,交给工具
使用方式新手用完整清单,熟手用关键项兜底

写好清单的要点

  • 条目要可检查:能回答是或否,而不是「注意保持良好设计」这类口号。
  • 条目要短:一页以内,超出就会被跳过。
  • 优先放高频且容易被忽略的项,例如错误处理与权限校验。
  • 把已经交给工具的项删掉,清单只留需要人判断的部分。
  • 每次出问题后回看清单:漏检的那一项该不该补进去。

有效清单与无效清单

特征有效无效
条目形式可回答是或否的具体问题口号式要求
长度一页以内,按技术栈裁剪几十条照抄通用模板
维护随问题类型更新长期不变,新风险一直漏检
用法专注高风险项逐格打钩但不看代码

短清单示例

短清单示例
# 按技术栈裁剪后的评审清单示例
# [ ] 错误分支是否被处理并留下可定位的信息
# [ ] 新接口是否挂了鉴权,能否访问他人的数据
# [ ] 配置与开关的默认值是否安全
# [ ] 数据迁移脚本能否重复执行
# [ ] 测试在改错实现时会不会失败
清单的价值在于降低注意力波动,而不是证明「已按清单评审」。
删掉不适用于本项目的条目,比为了完整而强行保留更有价值。
团队可以把线上事故的根因转成清单条目:每一条清单背后最好都有一个具体教训或明确风险。

易错点

  • 清单沦为勾选仪式:逐项打钩但没真正看代码,风险照样漏过。
  • 清单长期不更新:新类型的问题(如依赖漏洞、密钥泄漏)一直没人检查。
  • 清单过长:超出注意力容量后,评审者会整体跳过它。
  • 把清单当门禁指标考核:比谁勾得快,反倒鼓励走形式。

数据来源与参考

  • Google Engineering Practices · What to look for in a code review(检查项目录)
​‌‌​​‌​​​‌‌​‌‌‌‌​‌‌​​​‌‌​‌‌‌​​‌‌​​‌​‌‌‌​​‌‌‌​​​‌​‌‌​‌​​‌​‌‌‌​​​‌​‌‌​‌​​‌​‌‌​​​‌‌​‌‌‌​‌​​​‌‌​‌‌‌‌​​‌​‌‌‌​​‌‌​​​‌‌​‌‌​‌‌‌‌​‌‌​‌‌​‌