代码评审

代码评审的流程

谷歌的一个典型代码评审流程包括以下步骤:

image-20221208105140450

代码评审的好处

设计良好的代码评审流程和认真对待代码评审的文化提供了以下好处:

  • 检查代码正确性
  • 确保代码变更能够被其他工程师理解
  • 增强整个代码库的一致性
  • 心理上促进团队的责任感
  • 知识共享
  • 提供代码评审本身的历史记录

代码评审最佳实践

  • 礼貌而专业
  • 小的变更
  • 清晰的变更描述
  • 评审者数量最少化
  • 尽可能自动化

代码评审类型

不同类型的代码变更要求对评审过程的务个方 面给予不同程度的关注。

  • 绿地代码评审和新特性开发
    • 全新代码,即所谓的绿地评审。
    • 绿地评审是评估代码是否经得起时间考验的最重要时间。
    • 绿地评审应确保API与商定的设计相匹配,并经过充分测试。
  • 行为变更、改过和优化
    • 即,对现有代码的修改。
    • 消除无效或过时的代码是改进整体代码健康状况的最好办法之一。
  • 缺陷修复和回滚
    • 缺陷修复应该只关注修复指定的缺陷,不要去试图解决其他问题。
    • 变更尽可能小和原子化。
  • 重构和大规模变更

20200131220947.png

0%