Abstract	How to do code review
Authors	Walter Fan
Category	learning note
Status	v1.0
Updated	2022-09-10
License	CC-BY-NC-ND 4.0

Code review 是提高代码质量，传递知识的最有效方法之一。

前提

1. 要能完全看懂代码，业务不明白先搞懂业务，技术领域不清楚先搞懂技术领域
2. 要能明察秋毫，一丝不苟，不放过每一个隐患
3. 除了考虑正确性和性能，还有可维护性，可重用性，可运维性
4. 双方都要端正态度，顺畅沟通，全力配合

要求

1. 没有拼写错误，符合统一的代码风格
2. 代码性能够好，无较大的优化空间
3. 代码复杂性不宜过高，不宜冗长，要容易理解
4. 不要重复造轮子
5. 要有必要的注释
6. 要有必要的单元测试

方法

1. 自顶向下，搞清楚代码的目的和结构
2. 自底向上，搞清楚代码之间的交互与联系
3. 查看模块，类，方法的接口，搞清楚含义和动机
4. 查看模块，类，方法的内部逻辑，搞清楚数据结构，流程和算法
5. 有必要的话，随手画出类图，流程图或时序图

代码的臭味

1. 看不懂，接口和全名不清晰
2. 看得累，逻辑很绕, 啰嗦不清
3. 内聚太差，耦合太强
4. 参考“重构” 一书中描述的众多臭味

---

本作品采用知识共享署名-非商业性使用-禁止演绎 4.0 国际许可协议进行许可。