CSI__代码评审规范.docVIP

项目管理体系文件 代码评审规范 编 撰 人：TMO 审 核 人： 批 准 人： 批准日期：2010-9-1 保密级别：机密 文档版本：0.0.1 北京中软国际信息技术有限公司 文件修订历史 日期 版本 说明 作者 目　录 1. 代码评审(Code Review)简介 3 1.1 Code Review的目的 3 1.2 Code Review的前提 3 1.3 Code Review需要做什么 3 1.3.1 完整性检查（Completeness） 4 1.3.2 一致性检查（Consistency） 4 1.3.3 正确性检查（Correctness） 4 1.3.4 可预测性检查（Predictability） 4 1.3.5 健壮性检查（Robustness） 5 1.3.6 结构性检查（Structuredness） 5 1.3.7 可追溯性检查（Traceability） 5 1.3.8 可理解性检查（Understandability） 5 1.3.9 可验证性检查(Verifiability) 5 2. Code Review检查列表 5 2.1 JAVA编码规范方面检查项 5 2.2 面向对象设计方面检查项 6 2.3 性能方面检查项 6 2.4 资源泄漏处理方面检查项 6 2.5 线程安全方面检查项 6 2.6 程序流程方面检查项 7 2.7 数据库处理方面 7 2.8 通讯方面检查项 7 2.9 JAVA对象处理方面检查项 7 2.10 异常处理方面检查项 8 2.11 方法（函数）方面检查项 8 2.12 安全方面检查项 8 代码评审(Code Review)简介 Code Review的目的 凡事知其然还要知其所以然，我们首先需要知道什么是Code Review和我们使用它的目的是什么。Code Review是一种用来确认方案设计和代码实现的质量保证机制，通过这个机制我们可以对代码，测试过程和注释进行检查。Code Review主要用来在软件工程过程中改进代码质量，通过Code Review可以达到如下目的： 在项目早期就能够发现代码中的BUG 帮助初级开发人员学习高级开发人员的经验，达到知识共享 避免开发人员犯一些很常见，很普通的错误 保证项目组人员的良好沟通 项目或产品的代码更容易维护 Code Review的前提 知道了Code Review的目的，我们就可以看看如何做Code Review了，但在做Code Review前我们还有事要做，所谓预则立，不预则废，就是说如果在进入Code Review之前我们不做些准备工作，Code Review很容易就变得没有意义或是流于形式，这在我们周围是有很多例子的啊。进入Code Review需要检查的条件如下： a)?????? Code Review人员是否理解了Code Review的概念和Code Review将做什么 如果做Code Review的人员不能理解Code Review对项目成败和代码质量的重要程度，他们的做法可能就会是应付了事。 b)????? 代码是否已经正确的build，build的目的使得代码已经不存在基本语法错误 我们总不希望高级开发人员或是主管将时间浪费在检查连编译都通不过的代码上吧。 c)????? 代码执行时功能是否正确 Code Review人员也不负责检查代码的功能是否正确，也就是说，需要复查的代码必须由开发人员或质量人员负责该代码的功能的正确性。 d)????? Review人员是否理解了代码 做复查的人员需要对该代码有一个基本的了解，其功能是什么，是拿一方面的代码，涉及到数据库或是通讯，这样才能采取针对性的检查 e)?????? 开发人员是否对代码做了单元测试 这一点也是为了保证Code Review前一些语法和功能问题已经得到解决，Code Review人员可以将精力集中在代码的质量上。 Code Review需要做什么 Code Review主要检查代码中是否存在以下方面问题： 代码的一致性 编码风格 代码的安全问题 代码冗余 是否正确设计以满足需求（性能、功能等等） 完整性检查（Completeness） 代码是否完全实现了设计文档中提出的功能需求 代码是否已按照设计文档进行了集成和Debug 代码中是否存在任何没有定义或没有引用到的变量、常数或数据类型 一致性检查（Consistency） 代码的逻辑是否符合设计文档 代码中使用的格式、符号