如何做好Code Review：思考、方法和实践 （真实经验总结）

  

目录

背景

Code Review 目标

系统层面

代码规范

业务逻辑

日志

测试

安全

文档

---

背景

我一直认为Code Review（代码审查）是软件开发中的最佳实践之一，可以有效提高整体代码质量，及时发现代码中可能存在的问题。

然而对于我观察到的大部分软件开发团队来说，认真做Code Review的很少，有的流于形式，有的可能根本就没有Code Review的环节，代码质量只依赖于事后的测试。也有些团队想做好代码审查，但不知道怎么做比较好。

网上关于如何做Code Review的文章已经有很多了，这里我结合自身所在的交易业务线总结一些code review 的方法。

Code Review 目标

系统层面；

代码规范；

业务逻辑；

日志；

测试；

安全；

文档；

系统层面

1.包的分层是否合理？
2.类的设计是否合理？

代码规范

1.变量/方法/类/包注释是否有必要添加？
2.对现有的变量/方法/类/包是否有调整，文档或注释是否有更新？
3.方法/函数：A、方法命名；