代码走查

Code Review

Why - 为什么要做代码走查

  • 知识传递,了解团队里正在发生的事情
  • 团队代码实践标准对齐,让团队理解并遵守约定,如领域模型、设计理念、稳定性、可拓展性等等
  • 增近沟通和编码风格理解

What - 什么是代码走查

Code Review是来自极限编程(Extreme programming)里的实践。 结对编程是最常见的实践方式,和之互补的则是额外的代码走查,及必需的单元测试。
极限编程的目的是为了提高代码质量,强调计划和即时反馈,下面是经典的反馈环:
Support from fsky.top
可以看出结对编程是分钟级别的反馈,代码走查通常是以天为单位的反馈。实际情况下,需要这两种方式互相补充,以达到高质量代码的目标。

How - 怎么做代码走查

根据项目实际要求梳理统一维度,如重点如下,如何找到对应的维度:
  • 框架结构
  • 代码实现
维度
  • 设计
  • 测试
    • 架构测试
    • 分层测试
    • 单元测试
    • 功能测试
    • 集成测试
  • 易维护性
    • 重复代码
    • 可拓展性
  • 可读性 - CheckStyle & PMD
流程
  • Review已提交代码
  • 用DDD通用语言讲解上下文
  • 按测试层级介绍测试及实现代码

附录