java代码走查计划书

精品好资料——————学习推荐

WATER Corporation

代码走查计划书Version 2.0

XXX

2012/3/20

文档修改记录

目录

1.进度计划4

2.待评审物4

3.成员角色5

4.基本原则5

4.1代码评审原则5

4.2评审指导文档6

5.走查过程定义6

5.1代码走查计划准备阶段6

5.2个人代码走查阶段6

5.3代码走查会议阶段7

5.4缺陷修改与关闭7

1.进度计划

小组代码走查活动时间进度安排如下所示：

工作任务时间安排

制定编码规范文档3月20日19:00-21:00 制定代码走查CheckList，提交待评审项目3月21日19:00-21:00 评审人员执行个人走查，利用工具记录发现的问题3月22日13:00-15:00 小组走查会议，完成缺陷记录报告，3月22日15:00-16:30 开发人员完成代码修改3月23日9:00-12:30 评审人员再次走查修改过的代码3月24日19:00-20:30 跟踪发现的问题直至问题关闭3月25日9:00-11:00

2.待评审物

待评审物名称：银行系统取款模块源代码V1.0 （SC-Banking-Withdraw- V1.0）

Figure 1 UML Model for Banking-Withdraw

3.成员角色

组长：制定代码走查的计划、安排代码走查活动职责分工、组织代码走查，确保代码走查的过程规范执行；

质量保证人员：制定CheckList，记录代码走查会议以及完成问题记录报告；

开发人员：完成代码，在代码走查中引领走查人员读代码，走查结束后并根据走查的问题记录报告完成代码修改；

评审人员：依据编程规范和CheckList执行代码走查，使用Jupiter工具记录发现的问题。

4.基本原则

4.1 代码评审原则

1.一次检查少于200～400行代码

2.努力达到一个合适的检查速度：每小时少于300～500行代码

3.有足够的时间、以适当的速度、仔细地检查，但不宜超过60～90分钟

4.在复审前，代码作者应该对代码进行注释

5.建立量化的目标并获得相关的指标数据，从而不断改进流程

6.使用检查表（checklist）肯定能改进双方（作者和复审者）的结果

7.验证缺陷是否真正被修复

8.管理人员要营造良好的氛围（文化），使大家可以积极地对待缺陷的发现，发

现足够多的缺陷，只关心问题是什么、怎样引起的，而不关心是谁写的代码

9.清楚度量工具（"Big Brother"）的作用——度量工具是双刃剑，要小心使用

10.自我约束：即使没有时间完成所有代码的检查，也应该尽可能去做，哪怕是

一部分

11.轻量级的code review是高效率的、可行的，并能有效地发现缺陷

4.2 评审指导文档

附录1《JAVA编程规范》

附录2 《代码走查检查单》

5.走查过程定义

5.1 代码走查计划准备阶段

主要活动：

1.开发人员提交待评审代码及其需求文档，提出走查申请；

2.组长审核及批准走查申请；

3.QA制定走查计划、代码检查单及Java编程规范文档，生成待评审包；

4.组长将待评审包上传至SVN。

出口准则：待评审包（包含源代码及其需求文档、代码检查单和Java编程规范）5.2 个人代码走查阶段

主要活动：

1.小组人员安装代码走查工具Jupiter，下载待评审包，预读代码；

2.组长制定走查任务，将工具生成.Jupiter文件上传至SVN；

3.评审人员从SVN中获得.Jupiter文件，参照需求文档、代码检查单和Java编程规范，使用Jupiter插件记录所发现问题，完成个人走查，将生成.review文件上传至SVN；

4.QA收集并整合.review文件，用工具反编译生成Excel表格，生成个人走查问题记录单。

出口准则：整合后.review文件，个人走查问题记录单。

5.3 代码走查会议阶段

主要活动：

1.参会人员携带个人走查工作成果按时入场，由组长宣布小组走查会议开始；

2.由开发人员解释程序功能、实现方式、代码结构、主要业务和逻辑流程等，引导评审人员阅读代码，评审人员以轮流发言的方式提出个人走查时发现的问题，QA使用Jupiter工具记录此过程中发现的问题，生成小组走查问题清单。

3.组长带领与会成员浏览小组走查问题清单，定义缺陷严重级别，确定缺陷是否被开启，是否需要修改。

4.QA生成最终问题清单并开启缺陷，向组长通报走查结果，并告知开发人员和评审人员。

5.小组成员提交评审日志。

出口准则：小组走查.review文件，代码走查问题清单，个人评审日志。

5.4 缺陷修改与关闭

主要活动：

1.由开发人员对缺陷进行修改，使用Jupiter记录缺陷状况。

2.再次召开小组走查会议，直至所有缺陷均被关闭或挂起。

3.开发人员整理工作成果，并存入开发库。

4.组长和QA编写代码走查报告，QA整理评审文档，并入库。

出口准则：修改后代码，缺陷跟踪矩阵，代码走查报告。