Code Review的前提
==============
- 重视代码review
(Code Review人员是否理解了Code Review的概念和Code Review将做什么如果做Code Review的人员不能理解Code Review对项目成败和代码质量的重要程度,他们的做法可能就会是应付了事。)
- 代码是否已经正确的build,build的目的使得代码已 经不存在基本语法错误
(我们总不希望高级开发人员或是主管将时间浪费在检查连编译都通不过的代码上吧。 )
- 代码执行时功能是否正确
(Code Review人员也不负责检查代码的功能是否正确,也就是说,需要复查的代码必须由开发人员或质量人员负责该代码的功能的正确性。 )
- 开发人员是否对代码做了单元测试
(这一点也是为了保证Code Review前一些语法和功能问题已经得到解决,Code Review人员可以将精力集中在代码的质量上。 )
Code Review需要注意什么?
==================
- 完整性检查(Completeness)
-
代码是否完全实现了设计文档中提出的功能需求
-
代码是否已按照设计文档进行了集成和Debug
-
代码是否已创建了需要的数据库,包括正确的初始化数据
-
代码中是否存在任何没有定义或没有引用到的变量、常数或数据类型
- 一致性检查(Consistency)
-
代码的逻辑是否符合设计文档
-
代码中使
用的格式、符号、结构等风格是否保持一致
- 正确性检查(Correctness)
-
所有的变量都被正确定义和使用
-
所有的注释都是准确的
-
所有的程序调用都使用了正确的参数个数
- 可修改性检查(Modifiability)
-
代码涉及到的常量是否易于修改(如使用配置、定义为类常量、使用专门的常量类等)
-
代码是否只有一个出口和一个入口(严重的异常处理除外)
-
健壮性检查(Robustness)
-
可理解性检查(Understandability)
-
注释是否足够清晰的描述每个子程序
-
是否使用到不明确或不必要的复杂代码,它们是否被清楚的注释
-
使用一些统一的格式化技巧(如缩进、空白等)用来增强代码的清晰度
-
是否在定义命名规则时采用了便于记忆,反映类型等方法
-
每个变量都定义了合法的取值范围
-
代码中的算法是否符合开发文档中描述的数学模型
- 可验证性检查(Verifiability)
- 代码中的实现技术是否便于测试
Code Review经验检查项
================
1、 编码规范方面检查项
2、面向对象设计方面检查项
- 类设计和抽象是否合适
- 是否符合面向接口编程的思想
- 是否采用合适的设计模式
3、性能方面检查项
- 对hashtable,vector等集合类数据结构的选择和设置是否合适
- 有无滥用String对象的现象
- 是否采用通用的线程池、对象池模块等cache技术以提高性能
- I/O方面是否使用了合适的类或采用良好的方法以提高性能(如减少序列化,使用buffer类封装流等)
- 同步方法的使用是否得当,是否过度使用
4、数据库处理方面
- 数据库资源是否正常关闭和释放
- 数据库访问模块是否正确封装,便于管理和提高性能
- 是否采用合适的事务隔离级别
- 资源泄漏处理方面检查项 cursor
5、通讯方面检查项
- socket通讯是否存在长期阻塞问题
6、重复代码
7、其他
- 日志是否正常输出和控制
- 配置信息如何获得,是否有硬编码
怎么更有效的做Code Review
级别
- 资源泄漏处理方面检查项 cursor
5、通讯方面检查项
- socket通讯是否存在长期阻塞问题
6、重复代码
7、其他
- 日志是否正常输出和控制
- 配置信息如何获得,是否有硬编码
怎么更有效的做Code Review