以下为《代码评审规则指南》的无排版文字预览，完整格式请下载

下载前请仔细阅读文字预览以及下方图片预览。图片预览是什么样的，下载的文档就是什么样的。

一、Code Review简介

1 Code Review的目的

凡事知其然还要知其所以然，我们首先需要知道什么是Code Review和我们使用它的目的是什么。

Code Review是一种用来确认方案设计和代码实现的质量保证机制，通过这个机制我们可以对代码、测试过程和注释进行检查。

Code Review主要用来在软件工程过程中改进代码质量，通过Code Review可以达到如下目的：

在项目早期就能够发现代码中的BUG

帮助初级开发人员学习高级开发人员的经验，达到知识共享

避免开发人员犯一些很常见，很普通的错误

保证项目组人员的良好沟通

项目或产品的代码更容易维护

2 Code Review的前提

知道了Code Review的目的，我们就可以看看如何做Code Review了，但在做Code Review前我们还有事要做，所谓预则立，不预则废，就是说如果在进入Code Review之前我们不做些准备工作，Code Review很容易就变得没有意义或是流于形式，这在我们周围是有很多例子的啊。进入Code Review需要检查的条件如下：

Code Review人员是否理解了Code Review的概念和Code Review将做什么

如果做Code Review的人员不能理解Code Review对项目成败和代码质量的重要程度，他们的做法可能就会是应付了事。

代码是否已经正确的build，build的目的使得代码已经不存在基本语法错误

我们总不希望高级开发人员或是主管将时间浪费在检查连编译都通不过的代码上吧。

代码执行时功能是否正确

Code Review人员也不负责检查代码的功能是否正确，也就是说，需要复查的代码必须由开发人员或质量人员负责该代码的功能的正确性。

Review人员是否理解了代码

做复查的人员需要对该代码有一个基本的了解，其功能是什么，是拿一方面的代码，涉及到数据库或是通讯，这样才能采取针对性的检查

开发人员是否对代码做了单元测试

这一点也是为了保证Code Review前一些语法和功能问题已经得到解决，Code Review人员可以将精力集中在代码的质量上。

3 Code Review需要做什么

好了，进入条件准备好了，有人在这些条件中看到Code Review这也不负责，那也不检查，不禁会问，Code Review到底做什么？

其实Code Review主要检查代码中是否存在以下方面问题：代码的一致性、编码风格、代码的安全问题、代码冗余、是否正确设计以满足需求（性能、功能）等等

下边我们一一道来。以下内容参考了《Software Quality Assurance: Documentation and Reviews》一文中的代码检查部分。

3.1 完整性检查（Completeness）

代码是否完全实现了设计文档中提出的功能需求

代码是否已按照设计文档进行了集成和Debug

代码是否已创建了需要的数据库，包括正确的初始化数据

代码中是否存在任何没有定义或没有引用到的变量、常数或数据类型

3.2 一致性检查（Consistency）

代码的逻辑是否符合设计文档

代码中使用的格式、符号、结构等风格是否保持一致

3.3 正确性检查（Correctness）

代码是否符合制定的标准

所有的变量都被正确定义和使用

所有的注释都是准确的

所有的程序调用都使用了正确的参数个数

3.4 可修改性检查（Modifiability）

代码涉及到的常量是否易于修改(如使用配置、定义为类常量、使用专门的常量类等)

代码中是否包含了交叉说明或数 内容过长，仅展示头部和尾部部分文字预览，全文请查看图片预览。 I是否被良好定义，即是否尽量面向接口编程、便于维护和重构

12 安全方面检查项

对命令行执行的代码，需要详细检查命令行参数

web类程序检查是否对访问参数进行合法性验证

重要信息的保存是否选用合适的加密算法

通讯时考虑是否选用安全的通讯方式

13 其他

日志是否正常输出和控制

配置信息如何获得,是否有硬编码

三、总结

通过在项目中实施Code Review将为我们带来多方面的好处，表现在提高代码质量，保证项目或产品的稳定性，开发经验的积累等，具体的实施当然也要看项目的实际情况，因为 Code Review也是需要成本的，这方面属于Code Review过程的问题，将在其他文章中进行探讨。?

[文章尾部最后300字内容到此结束,中间部分内容请查看底下的图片预览]

以上为《代码评审规则指南》的无排版文字预览，完整格式请下载

下载前请仔细阅读上面文字预览以及下方图片预览。图片预览是什么样的，下载的文档就是什么样的。