首页/开发/代码质量与评审速查/评审者指南:按层次看改动
代码评审64 条

评审者指南:按层次看改动

Google 评审者指南:先看设计意图再看细节,关注点按'设计 → 功能 → 复杂度 → 测试 → 命名 → 风格'分层推进,风格细节交给工具。

评审者指南是什么

Google 评审者指南(How to do a code review)的实操要点:先看设计意图再看代码细节,关注点按「设计、功能、复杂度、测试、命名、风格」分层推进,风格细节交给工具。评审者的职责是确认这次改动让代码库变得更好,而不是把代码改成自己偏好的样子。

基本信息

文档How to do a code review(评审者指南)
推进顺序先整体意图,后代码细节
风格处理格式与风格交给格式化器和 lint,评论用 nit 前缀
沟通姿态有疑问先提问确认,再下判断
响应速度约一个工作日内给出回复
评审目标代码库整体变好,不是按个人偏好重写

评审关注层次

层次要回答的问题
设计改动是否放在系统的正确位置,与既有架构是否一致
功能行为是否符合意图,边界、异常、并发路径是否考虑
复杂度有没有更简单的实现,是否为假想需求过度设计
测试测试是否有效、能否失败,关键路径是否覆盖
命名命名是否表达意图,是否与领域术语一致
风格格式细节交给工具,人工评论只标 nit

操作顺序建议

  • 先读描述与关联工单,确认改动要解决的问题。
  • 扫一遍文件清单与规模,建立改动地图,决定阅读顺序。
  • 先读测试理解行为预期,便于判断覆盖与断言质量。
  • 逐一细读核心文件,对每处疑问当场记录评论。
  • 回到整体检查:设计是否合理、有没有更简单的替代方案。
  • 攒好评论一次性提交,减少作者收到的通知噪声。
不要从风格细节开始评:先确认整体方向正确,否则细节评审可能全部作废。
评审者不必替作者重写代码:指出问题与方向,具体实现留给作者。
对不确定的点用提问代替断言:作者的解释常能补上缺失的上下文。

易错点

  • 跳过设计只看代码行:方向错误时,细节评审全部作废。
  • 在评审里展开架构辩论:应尽快转到当面或异步讨论,先把本次改动处理完。
  • 把个人偏好当标准:作者被迫按评审者口味改写,团队风格反而更乱。
  • 先盯风格细节:大量 nit 淹没真问题,作者注意力被消耗。
  • 只看代码不看测试:行为正确性缺少独立验证。
  • 评审意见不给优先级:作者无从判断先改什么。

数据来源与参考

  • Google Engineering Practices · How to do a code review
​‌‌​​‌​​​‌‌​‌‌‌‌​‌‌​​​‌‌​‌‌‌​​‌‌​​‌​‌‌‌​​‌‌‌​​​‌​‌‌​‌​​‌​‌‌‌​​​‌​‌‌​‌​​‌​‌‌​​​‌‌​‌‌‌​‌​​​‌‌​‌‌‌‌​​‌​‌‌‌​​‌‌​​​‌‌​‌‌​‌‌‌‌​‌‌​‌‌​‌