自审是什么
自审就是在请人评审之前,把自己的完整 diff 当成别人的代码通读一遍。它的目标很具体:找回不该出现的内容(调试输出、注释掉的代码、无关文件),确认描述与改动一致,跑掉能在本地发现的低级问题。一次自审通常能省下一整轮评审往返,是投入产出比最高的一步。
基本信息
| 时机 | 改动完成、提交评审之前 |
|---|---|
| 读什么 | 完整 diff,而不是只看自己记得改的那几处 |
| 看什么 | 调试残留、无关文件、注释与描述是否准确、空白错误 |
| 配套动作 | 跑一遍本地测试与静态检查,确认结果可复述 |
自审命令示例
自审命令示例
git diff # 通读工作区改动
git diff --stat # 先看文件清单与规模
git diff --check # 查空白错误与冲突标记
# 再看:调试输出、注释掉的代码、TODO、临时文件是否清掉逐项自问
- 文件清单里有没有不该出现的文件(本地配置、日志、测试数据)。
- 调试输出、临时开关、注释掉的旧代码是否清干净。
- 描述里写的改动范围,与 diff 实际范围是否一致。
- 本地测试与静态检查跑过吗,结果说得清吗。
- 有没有把无关的格式化改动混进来,制造大量噪声。
- 提交信息与改动范围是否一致:写「修复登录」却夹带依赖升级,会误导后来人。
自审能拦住什么
| 问题 | 评审阶段的代价 |
|---|---|
| 调试输出残留 | 评审者提出来,作者再改一轮 |
| 误提交无关文件 | 需要撤回提交或补一个清理提交 |
| 描述与实际不符 | 评审者按错误前提评审,方向可能跑偏 |
| 本地测试未跑 | CI 报错后重新排队,交付延后 |
| 混入格式化改动 | 真实改动被淹没,评审质量下降 |
把 diff 当别人的代码来读:视角一换,很多低级问题当场就能发现。
自审不必追求一次看全:先扫文件清单与规模,再逐块细读,最后确认描述与验证方式。