代码评审制度

代码评审制度

代码评审也叫代码复查、Code review，是指通过阅读代码来检查源代码与编码标准的符合性以及代码质量的活动。

评审的内容

编码规范问题–命名不规范、magic number、System.out……；

代码结构问题–重复代码、巨大的方法和类、分层不当、紧耦合；

工具、框架使用不当–

实现问题–错误验证、异常处理、事务划分、线程、性能、安全、实现过于复杂、代码可读性不佳、扩展性不好；

测试问题–可测试性不好、测试覆盖度不够。

代码评审不负责检查功能、逻辑是否正确，这些靠单元测试和QA工作来解决。

代码评审的好处

●提高代码质量；

●在项目的早期发现缺陷，将损失降到最低；

●评审的过程也是重新梳理思路的过程，双方都加深了对系统的理解；

●促进团队沟通、促进知识共享、共同提高；

交叉评审——代码走查

交叉评审也就是团队成员互相检查代码。参与者可以是任意两个组员，或开发组长分别与每个组员结对进行。

评审时机在下班前半小时，对当天改动的模块进行评审。

代码作者讲解如何以及为何进行这样实现，评审者提出问题和建议。

每次评审需要做记录并保存到SourceSafe。

注意：每次评审不要贪多，当一次评审超过400行代码时，能发现的缺陷数显著降低——事倍功半。

会审

会审以项目为单位，召开专门的代码评审会议。参与者包括项目组全体成员，其他组的开发组长也应尽量参加。会审的时机选择在开发进行某一定阶段时，对共性问题进行总结，对好的做法进行提炼和推广。

会审之前需做好会前准备工作，组织者应通知各参与者本次评审的范围，参与者阅读代码，列出发现的问题、亮点，汇总给组织者。准备工作要细致，需要给出详细问题描述以及相关代码在SourceSafe上的地址等。

评审代码可以选择最近一次迭代开发的代码、系统关键模块、业务较复杂的模块或缺陷率较高的模块。

会议的议程，如果是第一次会议，先由改项目组长做整体介绍，参与者依次发言，结合

代码讲解发现的问题，每讲解完一个问题，针对其展开讨论，每个问题控制在10分钟内；如果问题不多，还可以安排组成员对最近开发的代码进行地毯式的讲解和排查；或者针对某个方面对整个项目做评审，例如性能、安全性或测试。

会后总结，把会上提出的所有问题、亮点及最终结论详细的记录下来，供其他团队借鉴。未能讨论清楚的问题，会后解决。

实行代码评审制度前的准备工作

架构师提供开发规范、指南，为代码评审提供依据。

建立单元测试规范，否则无法达到测试覆盖率的要求、难以修正发现的问题。