如何做代码评审（code review）

1. 定义

Code Review 即日常所说的代码评审或代码回顾，主要是在软件开发的过程中，对功能源代码进行评审，其目的是找出并修正软件开发过程中出现的错误的过程，提高和改进代码质量的过程。

2. 目的

2.1 提前发现缺陷
code review 能够一定程度上提前发现代码中存在的bug和潜在的性能问题，降低线上故障率。

2.2 寻求改进的解决方案
code review能够检查开发者代码是否符合开发规范，逻辑是否清晰，代码组织是否合理，帮助其改善代码设计和解决方案。对问题进行记录，事后跟踪闭环，并形成经验总结，避免后续出现同样的问题。

2.3 团队互动与学习
增强团队成员之间沟通，学习他人良好的代码设计方案，提升专业技能。

2.4 不断改进code base的健康度
始终保证随着时间的推移，公司代码越来越健康

2.5 人员备份
code review能够让评审人员及参与人员大致的理解所修改代码的含义，熟悉这块业务代码，在特定时间能够有人做backup。

3. 前提

1 change log 备注明确，见参考文档[4]
2 git commit 备注信息要明确，每个commit代码尽量独立
3 开发人员清晰表达实现方案、逻辑和改进点

4. 关注点

1 合理的设计
2 功能正常
3 复杂度，防止过度设计
4 适当的单元测试
5 命名的规范性
6 注释的必要性
7 代码风格是否符合现有规范
… …

5. 形式

1 Team Review，团队review
2 Peer Review，同伴review

6. 工具

工具方式githubpull requestgitlabmerge requestgiteemerge request

7 最佳实践

1 轻量级的code review
2 最好有一定的规范，而非标准
3 从开发者角度思考问题，评论要写清楚原因和给予指导
4 提出的是建议，非强制修改

参考文档

1 https://google.github.io/eng-practices/
2 https://google.github.io/eng-practices/review/reviewer/
3 https://xindoo.github.io/eng-practices-cn/review/reviewer/
4 https://google.github.io/eng-practices/review/developer/cl-descriptions.html