如何执行代码走查活动才会有效呢

首先,在系统设计阶段,我们需要明确系统架构、编码规范等技术要求,来制定出代码走查活动需要的Checklist(对于编码规范,当可以利用工具来进行检查时,准备的Checklist中就不需要将工具可以检查的要点再逐一列出来。)
第二步是确定代码走查时发现问题的记录方式。可以使用文档的方式来记录(这在很多项目中使用),也可以使用缺陷跟踪系统来记录。

当准备工作完成,且项目进入Coding阶段后,我们就可以正式开始执行代码走查活动了。为了改变以前那种事后检查的弊端,我们将代码走查活动前移到与程序员的Coding同步进行。这样做就是为了及时发现问题及时解决问题。实施的步骤如下:

1)、负责代码走查的人员从建构库中获取需要走查的代码;

2)、阅读代码,并根据前面准备好的Checklist对代码进行检查,看代码是否符合相关的技术要求,以及是否满足业务需求,发现的问题及时记录下来;

TIPS: 通常可以在阅读代码之前或者阅读完代码之后,利用工具来进行必要的Check。可以利用的工具有:Checkstyle, CodePro, FindBugs, Metrics, JDepend等等。

3)、阅读代码的过程中,如果发现有可供提取的可重用方法或模块,及时记录并通报给项目的架构负责人,由其负责可重用方法的编写;

4)、及时向程序员通报代码走查的结果,并由程序员对发现的问题进行修改。必要时对代码走查中发现的问题需及时向程序员进行讲解和指导;

5)、跟踪代码走查中发现的问题的解决进展,直到问题均关闭;

6)、每日重复以上的步骤,直到所有功能的编码全部结束为止。

通过以上代码走查活动的说明,可看出代码走查人员在项目中承担着比较重要的角色。因此安排合适的人来进行代码走查也显得格外重要,可以说直接关系着代码走查活动的最终成效。

通常我们可考虑安排功能的设计者来负责该功能的代码走查。这样有几个好处:

一是功能的设计者对于功能的业务需求比较清楚,这样在做代码走查时就容易了解程序员编写的代码是否能够满足设计的要求和业务需求。其实从另外一个角度来看也是对设计的一种检查;

二是通常功能的设计者都是较资深的人员,可以为程序员提供有效地指导和协助,从另外一个角度也是对程序员的On-Job Training。

在实施代码走查的过程中,我们还需要借助工具来提高我们的效率,但切忌过分依赖工具或者仅仅只靠工具。同时也需要转变为了代码走查而代码走查的倾向,因为那样就不能发挥代码走查的作用,并最终达到代码走查的目的。

从实践来看,代码走查时记录问题的方式也影响到代码走查的效率。这里向大家介绍一个在Eclipse中进行代码走查的插件——Jupiter。它提供了一种简单而便捷的方式来记录和跟踪代码走查时发现的问题。

你可能感兴趣的:(eclipse,工作,活动,文档,工具,Training)