如何提高代码质量(管理篇):代码复查

也许你是一位项目经理,也许你是一位项目骨干成员,或者开发小组长。在我发表“如何提高代码质量”的这一系统文章后,有许多网友都向我抱怨,说他无法把握整个项目组成员的代码质量。我想,这也是所有项目组普遍存在的问题吧,它通常表现为以下几个问题:

软件项目普遍存在的问题

1)新手。任何项目组成员都不可避免地出现新手,他们往往是刚刚从大学毕业的学生。这些新手由于软件开发时间太短,往往技术不成熟,没有形成良好的开发习惯,所以编写代码质量较差,问题很多。他们常常成为项目组的“鸡肋”,用多了项目质量无法得到保证,不用则又人手不够。

2)人员变动。一个维护时间稍长一点儿的软件项目,人员变动是在所难免的。老员工被调动到其它项目去了,由新员工来接替他们的工作。在我的项目组中,人员调动达到了90%,唯一没有调走的就是我自己。新员工在接替老员工进行代码维护,甚至继续进行新的开发的时,由于对原有代码以及设计思路理解的偏差,也会出现大量的低劣代码。

3)不规范的代码编写。即使除去以上两个问题的影响,项目组成员编写的代码同样会出现问题。在项目开发之初,我们往往会制定一个代码编写的规范,但在项目开发过程中,许多成员往往会忽视这些代码规范而进行随意的编写。随意地代码编写会降低代码的可读性、可维护性和易变更性。那么,我们应当采用什么样的管理措施,保证代码的规范,提高代码的质量呢?

以上问题,也是我在项目开发中不断摸索和思考的问题,而一些有经验的项目经理给出了他们的解决之道,那就是“代码复查”。

什么是代码复查

代码复查(Code Review),又叫“代码审查”,其基本思想就是,在开发人员编写完自己的代码后,由其他人来复查他写的代码,从而有效地发现代码中存在的缺陷。代码复查的一个基本理论就是,当我们越早发现代码存在的缺陷,我们解决缺陷的代价就越低。代码复查往往分成以下一个方面进行审查:

1)代码风格。在项目开发之初,我们往往会制定一个代码编写的规范,实际上,这个代码规范就包含了整个项目组的代码风格。由于软件开发人员的设计习惯不同,如果不统一代码风格,一个项目中的代码将五花八门,如变量和常量的命名、接口与实现类的注释、何时回车、怎样缩进等等。一个五花八门的设计风格,必将为日后的维护与改进带来困难。我们通过代码复查,一方面督促开发人员按照规范编写代码,另一方面也使开发人员自身形成良好的编程习惯。代码风格的审查,由于内容比较单一,我们常常可以通过一些代码复查的工具来自动完成,提高复查的效率。

2)重大缺陷。在一些关于代码复查的文章中,列出了一个常常的单子,描述了代码复查应当着重注意的重大缺陷,它们包括:存在SQL注入、易受跨站点脚本攻击、缓存区溢出、托管代码等等。项目组可以不断积累重大缺陷的审查项目,并在每次审查中逐一检查。重大缺陷审查是一个繁琐而细致的工作,如果能编写或使用一些审查软件,可以大大提高我们的审查效率。

3)设计逻辑与思路的审查。我认为,这部分的审查是代码复查中最核心、最有价值的部分。代码风格与重大缺陷的审查,虽然重要但简单而机械,可以通过软件自动检查;而设计逻辑与思路的审查,却是复杂而有深度的审查,需要有一定理论深度和编码经验的人才能完成,而且对新手尤其重要。前面提到,新手是任何项目组不可避免的问题。但遗憾的是,许多项目经理的办法是,只将一些简单而少量的工作交给新手完成,而将大量复杂的工作交给人数不多的那些老手来完成。这样的结果是,新手始终是新手,他们没有经过足够的锻炼;老手累死累活,无法指望新手予以分担工作。对于这个问题,我的办法是,通过代码复查,让老手去指导新手,让团队整体素质达到提高。具体办法就是,在新手完成编码以后,让老手去进行代码复查,指出新手的问题,指导新手设计。这样的过程最初可能需要重构,甚至重新编码。但经过这样的过程,新手将逐渐熟练,迅速成为老手,使整体团队素质提高。

代码复查的形式及优缺点

查看本栏目更多精彩内容:http://www.bianceng.cnhttp://www.bianceng.cn/Programming/project/

经过以上的描述,我们可以发现代码复查的优点显而易见。首先,通过对代码风格与规范的审查,可以大大提高代码的可读性与可维护性。现在的软件,往往需要持续的维护与升级,人员变动也在所难免,因此代码的可读性与可维护性尤为重要。代码复查是一种鞭策,因为它的存在,督促着开发人员自觉地规范编码,养成好的编码习惯,提高代码质量。一个值得注意的问题是,如果你不去读别人的代码,永远不能深刻理解什么是可读的代码,而自己的代码不让别人去读并且反馈,也永远不知道自己的代码是否可读,即使你是一个编码多年的老手。代码复查恰恰解决了这个问题,值得你去尝试。

其次,代码复查是一次程序员之间的交流。新手可以有更多的机会向老手学习和指导,提高自身的设计水平(应当说这对于他们是非常宝贵的);老手通过对新手的指导,整理和升华自己的设计思路与理论,同时也是对自己另一方面的锻炼与提高。另外,当你发现并指出了别人的一个问题以后,同时也是在警示自己不要犯同样的错误,这对审查与被审查者都是有益的。

虽然代码复查有如此突出的优点,但它的缺点也是非常显著的,那就是它需要付出如此巨大的代价。当一个人完成编码以后,还需要另外的人去解读和审查,并要求编程人员完成相应的修改,甚至重构和重写,这本身就是一种巨大的代价。这对于其本身就已经人员和时间非常紧张的软件开发项目来说,无疑是一种雪上加霜。时间、人力与代码质量,其本身就是鱼和熊掌不可兼得,关键是如何去权衡。正因为如此,不同公司选择了不同的代码复查策略。

前不久,我听了韩国一家大型游戏软件公司谈他们的代码复查。由于这家公司在软件开发时,时间和人力不是最关键和紧要的问题而代码质量,所以他们采用了一种严格的代码复查策略。严格的代码复查策略,一种方式是由专人进行代码复查。这种方式,在人员组织形式上,从软件开发人员中单独提出了一些经验丰富的人,组成一个代码复查小组,专职对其它软件开发小组进行代码复查。这种方式,代码复查小组以第三方的身份去复查各个项目组的代码,可以保证复查的公平公正,但压力无疑是巨大的(想想他们要查看那么多的代码)。

另一种方式,是以一个项目开发小组为单元进行代码互查,即一个人的代码,要为小组所有成员进行审查。这种方式毫无疑问,其付出的代价太大了。对这种方式的一种变通方式是将XP中的结对编程进行结合,然结对编程中的两个人相互进行代码互查。采用结对编程的项目组可以尝试这样方式,遗憾的是目前国内采用结对编程的项目组实在太少了。以上两种代码复查的最大弊病就是责任制,即审查者没有太多的责任去发现被审查者的问题,发现了问题对审查者没有任何好处,反倒与被审查者结怨;相反,审查者没有发现问题也不会担负任何责任。这样的结果就导致了代码复查流于形式:审查者草草审查,各方皆大欢喜,问题依然存在。

综上所述,虽然代码复查优势明显,但以上几种形式都不能为普通的软件开发团队所接受,就此我祭出了我的最佳实践:以小组为单位,组长责任制的代码复查形式。

代码复查的最佳实践

代码复查是有代价的,甚至有时是巨大的,因此代码复查不宜频繁,最好一份代码只审查一次。同时,代码复查者应当对所审查的代码负有责任,即能够大胆地审查并指出被审查者的问题,并要求被审查者限期整改。与此同时,被审查后的代码如果还出现缺陷,审查者应当负有责任。只有满足了以上三个条件,代码复查才能为我们所接受。毫无疑问,项目开发小组的组长来担当此责任是最合适的。

一个项目开发组,根据其功能的划分,可以划分为多个小组,每个小组负责一个子模块。在这样一个小组中,小组长无疑是最有经验的开发人员,由他去负责组织和指导其它成员是合适的。小组成员不要太多,往往是3~5人。小组长不要分配太多的开发任务,他的主要工作是指导和监督小组其它成员进行开发。将他从繁重的开发任务中解脱出来,他可以有更多的精力去指导其他成员的设计,并且复查他们的代码。最终,他要对小组所有成员的代码质量负责,由项目经理或质量管理员进行抽查,检验其整体情况。

如果你只是一个小型项目,人员总共在5人之内,那么你不用这样分组。作为项目经理的你就是那个小组长,指导和监督你的成员。这样安排是因为在现代的管理理论中认为,一个人最多只能管理5个人,超过5个人就应当分组管理。而如果你在5人之内当然就不需要分开啦。

作为组长,你可以有效地审查和管理你的小组成员。同时,由于你负有责任,你也不得不认真有效地去完成审查工作。通过以上的组织形式,代码复查可以简便有效地在项目组中开展起来,从而从管理上有效地提高软件开发的代码质量。

时间: 2024-08-05 13:42:13

如何提高代码质量(管理篇):代码复查的相关文章

三年0故障总结,提升代码质量的秘诀

该文章来自于阿里巴巴技术协会(ATA)精选文章. 个人经历 对我代码质量影响最大的是在一家外资企业,在这家公司我觉得有以下几个方面做的很不错. 团队编码风格统一 统一到什么程度? 不看代码作者,你很难区分代码是谁写的(在目前公司一些团队也能达到这个标准). 个人观点: 这样做有什么好处?团队中每个人阅读代码都很容易,减少很多沟通,维护成本( 代码阅读的次数远远大于变更的次数),并且心情非常愉悦.有人肯定觉得愉悦有点夸张,举个栗子: 有一些代码,如果不是由于与工作内容有关联,你是否有种这辈子都不情

《JavaScript专家编程》——9.4 度量JavaScript代码质量

9.4 度量JavaScript代码质量 为了让计算精度上升到最高,客观质量分析以程序化的方式对代码进行分析.这项任务可以使用编程工具完成,这些工具能够在多种情况下评估代码,根据各项指标得到最终的质量得分.本节介绍了静态代码分析,这种方法非常适合评估JavaScript的质量. 静态代码分析 静态代码分析就是不通过运行代码来分析代码的过程.静态分析看起来非常像一个文本编辑器的拼写检查器.拼写检查器扫描文档的正文来寻找错误和含糊之处,而并不需要了解文本的意义.同时,静态代码分析从功能上分析源代码的

提高代码质量:代码审查

在项目开发中,代码质量是非常重要的一环.高质量的代码对项目完成质量.能否按时完工有重大影响.而一个团队中开发成员的配置往往是金字塔形的.基于开发成本考虑,项目主管或小组长一般由经验丰富的资深高级程序员担任,开发成员则由普通程序员.新员工.实习生组成.各个开发成员水平参差不齐,以及该行业内开发人员的高流动性.这样的条件和环境必然带来代码质量问题.项目主管难于把握项目进度,很容易造成项目延期,即使加班不少. 既然问题存在了,就必须解决它.解决的思路就是代码审查. 代码审查的前提: 1.统一项目组内部

11步提高代码质量和整体工作效率

  这篇文章要介绍的,是我作为专业程序员这些年来学到的能真正提高我的代码质量和整体工作效率的11件事情. 1. 永远不要复制代码 不惜任何代价避免重复的代码.如果一个常用的代码片段出现在了程序中的几个不同地方,重构它,把它放到一个自己的函数里.重复的代码会导致你的同事 在读你的代码时产生困惑.而重复的代码如果在一个地方修改,在另外一个地方忘记修改,就会产生到处是bug,它还会使你的代码体积变得臃肿.现代的编程语 言提供了很好的方法来解决这些问题,例如,下面这个问题在以前很难解决,而如今使用lam

使用JSLint提高JS代码质量方法分享

这篇文章主要介绍了JSLint提高JS代码质量的方法,有需要的朋友可以参考一下 随着富 Web 前端应用的出现,开发人员不得不重新审视并重视 JavaScript 语言的能力和使用,抛弃过去那种只靠"复制 / 粘贴"常用脚本完成简单前端任务的模式.JavaScript 语言本身是一种弱类型脚本语言,具有相对于 C++ 或 Java 语言更为松散的限制,一切以函数为中心的函数式编程思想也为开发人员提供了更加灵活的语法实现.然而,这种灵活性在带来高效的同时,也成为初学或者经验不足的 Jav

如何提高你代码质量

人跟人的能力千差万别,所以写出来的代码质量,肯定是不同的.有的人,写一个小逻辑,可能需要100行,而有的人,可能仅仅需要10行.代码永远会有Bug,在这方面没有最好只有更好.模块化与面向对象是实现高效无错代码的方法.高效无错代码需要思想与实践的不断反复.如何做到代码高效无错,提高代码质量的方法有哪些?又有哪些经验和技巧呢? 一.代码质量   软件是交付给用户,并由用户体验的产品:代码则是对软件正确且详细的描述,所以代码质量关系到软件产品的质量.虽然软件质量不等于代码质量,但是代码上的缺陷会严重的

提高代码质量-工具篇

注:这是一篇翻译文章,原文:How to improve quality and syntax of your Android code,为了理解连贯,翻译过程中我修改了一些陈述逻辑和顺序,同时也加了一些自己的补充. 在这片文章中,我将从工具使用的角度上讲述如何提高 Android 代码质量,这些自动化工具包括 Checksytle.Findbugs.PMD 和 Android Lint. 团队中代码意识不一致,水平参差不齐,代码风格迥异,定下的规范也是熟视无睹.这时候就需要借助工具的力量,利用

提高代码质量:如何编写函数

提高代码质量:如何编写函数 函数是实现程序功能的最基本单位,每一个程序都是由一个个最基本的函数构成的.写好一个函数是提高程序代码质量最关键的一步.本文就函数的编写,从函数命名,代码分布,技巧等方面入手,谈谈如何写好一个可读性高.易维护,易测试的函数. 命名 首先从命名说起,命名是提高可读性的第一步.如何为变量和函数命名一直是开发者心中的痛点之一,对于母语非英语的我们来说,更是难上加难.下面我来说说如何为函数命名的一些想法和感受: 采用统一的命名规则 在谈及如何为函数取一个准确而优雅的名字之前,首

使用JSLint提高JS代码质量方法分享_javascript技巧

随着富 Web 前端应用的出现,开发人员不得不重新审视并重视 JavaScript 语言的能力和使用,抛弃过去那种只靠"复制 / 粘贴"常用脚本完成简单前端任务的模式.JavaScript 语言本身是一种弱类型脚本语言,具有相对于 C++ 或 Java 语言更为松散的限制,一切以函数为中心的函数式编程思想也为开发人员提供了更加灵活的语法实现.然而,这种灵活性在带来高效的同时,也成为初学或者经验不足的 JavaScript 开发人员的噩梦.形式各异的代码风格.隐含错误的代码行为,严重影响