代码评审怎么做，做到什么程度合适？

来自：http://www.iteye.com/topic/339832

 

最近在考虑在公司建立代码评审的机制，发现不像想象的那么简单：
代码评审的好处是毋庸置疑的，但也要付出成本，
而且评审别人的代码是一个比较敏感的事，所以具体操作的时候也有许多要注意的问题。
下面是我整理的文档准备开会讨论：


什么是代码评审：
代码评审也称代码复查，是指通过阅读代码来检查源代码与编码标准的符合性以及代码质量的活动。
通过工具来进行code review不在本次讨论范围内。

评审的内容：
编码规范问题：命名不规范、magic number、 System.out……
代码结构问题：重复代码、巨大的方法和类、分层不当、紧耦合
工具、框架使用不当：Spring、Hibernate、AJAX
实现问题：错误验证、异常处理、事务划分、线程、性能、安全、实现过于复杂、代码可读性不佳、扩展性不好
测试问题：测试覆盖度不够、可测试性不好
代码评审不负责检查功能、逻辑是否正确，这些要靠单元测试和QA工作来解决

代码评审的好处：
提高代码质量

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

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

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

交叉评审——代码走查：团队成员互相检查代码
参与者可以是任意两个组员，或开发组长分别与每个组员结对进行
时机可以选择在下班前半小时，对当天改动的模块进行评审
代码作者讲解如何以及为何这样实现、评审者提出问题和建议
每次解决的问题要记录到SVN注释或JIRA
每次评审不要贪多，如下图所示：当一次评审超过400行代码时，能发现缺陷数显著降低——事倍功半

会审：以项目为单位，召开专门的代码评审会议
参与者：包括项目组全体成员，其它组的开发组长也应尽量参加
时机选择：开发进行到某一阶段时，对共性问题进行总结，对好的做法进行提炼和推广
会前准备工作：
组织者应通知各参与者本次评审的范围
参与者阅读源代码，列出发现的问题、亮点，汇总给组织者
准备工作要细致，需要给出问题详细描述以及相关代码在SVN上的URL地址等
评审代码的选择：
最近一次迭代开发的代码
系统关键模块
业务较复杂的模块
缺陷率较高的模块
会议议程：
如果是第一次会议，先由该项目开发组长做整体介绍
参加者依次发言，结合代码讲解发现的问题
每讲完一个问题，针对其展开讨论，每个问题控制在10分钟以内
如果问题不多，还可以安排该组成员对最近开发的代码进行地毯式的讲解和排查；或者针对某个方面对整个项目做评审，例如性能、安全性或测试

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

实行代码评审制度前的准备工作：
架构师提供开发规范、指南，为代码评审提供依据
建立起单元测试规范，否则无法达到测试覆盖度的要求、难以修正发现的问题
最好有样例代码库作参照，以提高代码评审的可操作性
提供评审案例：用评审前的代码与评审后优化的代码做对比
问题跟踪：对评审中发现的问题代码应加以跟踪，确保问题得以解决，防止复发
评审到什么程度：
进行全面的代码评审成本较高，也没有必要

对发现的问题要本着集体代码所有制的观点和就事论事的原则，因此建议把代码质量与团队绩效（而不是个人绩效）挂钩。