原文链接:https://blog.csdn.net/c5153000/article/details/6295171
一、概述
代码审查(Code Review)是消灭Bug最重要的方法之一,这些审查在大多数时候都特别奏效。由于代码审查本身所针对的对象,就是俯瞰整个代码在测试过程中的问题和Bug。并且,代码审查对消除一些特别细节的错误大有裨益,尤其是那些能够容易在阅读代码的时候发现的错误,这些错误往往不容易通过机器上的测试识别出来。
1.1主要工作
1、发现代码中的bug;
2、从代码的易维护性、可扩展性角度考察代码的质量,提出修改建议。
3、是否符合java开发规范和代码审核检查表
1.2 基本流程
1、代码编写者和代码审核者坐在一起,由代码编写者按照UC(Use Case)依次讲解自己负责的代码和相关逻辑,从表现层->持久层;
2、代码审核者在此过程中可以随时提出自己的疑问,同时积极发现隐藏的bug;对这些bug记录在案。
3、代码讲解完毕后,代码审核者给自己安排几个小时再对代码审核一遍。 代码需要一行一行静下心看。同时代码又要全面的看,以确保代码整体上设计优良。
4、代码审核者根据审核的结果编写“代码审核报告”,“审核报告”中记录发现的问题及修改建议,然后把“审核报告”发送给相关人员。
5、代码编写者根据“代码审核报告”给出的修改意见,修改好代码,有不清楚的地方可积极向代码审核者提出。
6、代码编写者 bug fix完毕之后给出反馈。
7、代码审核者把Code Review中发现的有价值的问题更新到”代码审核检查表”的文档中,对于特别值得提醒的问题可群发email给所开发人员。
1.3 责任
代码编写者,代码审核者共同对代码的质量承担责任。这样才能保证Code Review不是走过场,其中代码编写者承担主要责任,代码审核者承担次要责任。
2.java代码审查检查表V1.0
| 重要性 | 激活 | 级别 | 检查项 |
|---|---|---|---|
| 总计 | |||
| 命名 | |||
| 重要 | 20 | 命名规则是否与所采用的规范保持一致? | |
| 20 | 是否遵循了最小长度最多信息原则? | ||
| 重要 | 50 | has/can/is前缀的函数是否返回布尔型? | |
| 注释 | |||
| 重要 | 10 | 注释是否较清晰且必要? | |
| 重要 | Y | 10 | 复杂的分支流程是否已经被注释? |
| 10 | 距离较远的}是否已经被注释? | ||
| 10 | 非通用变量是否全部被注释? | ||
| 重要 | Y | 50 | 函数是否已经有文档注释?(功能、输入、返回及其他可选) |
| 10 | 特殊用法是否被注释? | ||
| 声明、空白、缩进 | |||
| 20 | 每行是否只声明了一个变量?(特别是那些可能出错的类型) | ||
| 重要 | 40 | 变量是否已经在定义的同时初始化? | |
| 重要 | 40 | 类属性是否都执行了初始化? | |
| 20 | 代码段落是否被合适地以空行分隔? | ||
| Y | 20 | 是否合理地使用了空格使程序更清晰? | |
| 20 | 代码行长度是否在要求之内? | ||
| 20 | 折行是否恰当? | ||
| 语句/功能分布/规模 | |||
| 20 | 包含复合语句的{}是否成对出现并符合规范? | ||
| 20 | 是否给单个的循环、条件语句也加了{}? | ||
| 20 | if/if-else/if-else if-else/do-while/switch-case语句的格式是否符合规范? | ||
| 40 | 单个变量是否只做单个用途? | ||
| 重要 | 20 | 单行是否只有单个功能?(不要使用;进行多行合并) | |
| 重要 | 40 | 单个函数是否执行了单个功能并与其命名相符? | |
| Y | 20 | 操作符++和— —操作符的应用是否复合规范? | |
| 规模 | |||
| 重要 | 20 | 单个函数不超过规定行数? | |
| 重要 | 100 | 缩进层数是否不超过规定? | |
| 可靠性(总则/变量和语句) | |||
| 重要 | 100 | 是否已经消除了所有警告? | |
| 重要 | Y | 40 | 常数变量是否声明为final? |
| 重要 | 80 | 对象使用前是否进行了检查? | |
| 重要 | 80 | 局部对象变量使用后是否被复位为NULL? | |
| 重要 | 70 | 对数组的访问是否是安全的?(合法的index取值为[0, MAX_SIZE-1])。 | |
| 重要 | 20 | 是否确认没有同名变量局部重复定义问题? | |
| 20 | 程序中是否只使用了简单的表达式? | ||
| 重要 | Y | 20 | 是否已经用()使操作符优先级明确化? |
| 重要 | Y | 20 | 所有判断是否都使用了(常量==变量)的形式? |
| 80 | 是否消除了流程悬挂? | ||
| 重要 | 80 | 是否每个if-else if-else语句都有最后一个else以确保处理了全集? | |
| 重要 | 80 | 是否每个switch-case语句都有最后一个default以确保处理了全集? | |
| 80 | for循环是否都使用了包含下限不包含上限的形式?(k=0; k<MAX) | ||
| 重要 | 40 | XML标记书写是否完整,字符串的拼写是否正确? | |
| 40 | 对于流操作代码的异常捕获是否有finally操作以关闭流对象? | ||
| 20 | 退出代码段时是否对临时对象做了释放处理? | ||
| 重要 | 40 | 对浮点数值的相等判断是否是恰当的?(严禁使用==直接判断) | |
| 可靠性(函数) | |||
| 重要 | Y | 60 | 入口对象是否都被进行了判断不为空? |
| 重要 | Y | 60 | 入口数据的合法范围是否都被进行了判断?(尤其是数组) |
| 重要 | Y | 20 | 是否对有异常抛出的方法都执行了try…catch保护? |
| 重要 | Y | 80 | 是否函数的所有分支都有返回值? |
| 重要 | 50 | int的返回值是否合理?(负值为失败,非负值成功) | |
| 20 | 对于反复进行了int返回值判断是否定义了函数来处理? | ||
| 60 | 关键代码是否做了捕获异常处理? | ||
| 重要 | 60 | 是否确保函数返回CORBA对象的任何一个属性都不能为null? | |
| 重要 | 60 | 是否对方法返回值对象做了null检查,该返回值定义时是否被初始化? | |
| 重要 | 60 | 是否对同步对象的遍历访问做了代码同步? | |
| 重要 | 80 | 是否确认在对Map对象使用迭代遍历过程中没有做增减元素操作? | |
| 重要 | 60 | 线程处理函数循环内部是否有异常捕获处理,防止线程抛出异常而退出? | |
| 20 | 原子操作代码异常中断,使用的相关外部变量是否恢复先前状态? | ||
| 重要 | 100 | 函数对错误的处理是恰当的? | |
| 可维护性 | |||
| 重要 | 100 | 实现代码中是否消除了直接常量?(用于计数起点的简单常数例外) | |
| 20 | 是否消除了导致结构模糊的连续赋值?(如a= (b=d+c )) | ||
| 20 | 是否每个return前都要有日志记录? | ||
| 20 | 是否有冗余判断语句?(如:if (b) return true; else return false;) | ||
| 20 | 是否把方法中的重复代码抽象成私有函数? | ||
