也许你是一位项目经理,也许你是一位项目骨干成员,或者开发小组长。在我发表“如何提高代码质量”的这一系统文章后,有许多网友都向我抱怨,说他无法把握整个项目组成员的代码质量。我想,这也是所有项目组普遍存在的问题吧,它通常表现为以下几个问题:
软件项目普遍存在的问题
1)新手。任何项目组成员都不可避免地出现新手,他们往往是刚刚从大学毕业的学生。这些新手由于软件开发时间太短,往往技术不成熟,没有形成良好的开发习惯,所以编写代码质量较差,问题很多。他们常常成为项目组的“鸡肋”,用多了项目质量无法得到保证,不用则又人手不够。
2)人员变动。一个维护时间稍长一点儿的软件项目,人员变动是在所难免的。老员工被调动到其它项目去了,由新员工来接替他们的工作。在我的项目组中,人员调动达到了90%,唯一没有调走的就是我自己。新员工在接替老员工进行代码维护,甚至继续进行新的开发的时,由于对原有代码以及设计思路理解的偏差,也会出现大量的低劣代码。
3)不规范的代码编写。即使除去以上两个问题的影响,项目组成员编写的代码同样会出现问题。在项目开发之初,我们往往会制定一个代码编写的规范,但在项目开发过程中,许多成员往往会忽视这些代码规范而进行随意的编写。随意地代码编写会降低代码的可读性、可维护性和易变更性。那么,我们应当采用什么样的管理措施,保证代码的规范,提高代码的质量呢?
以上问题,也是我在项目开发中不断摸索和思考的问题,而一些有经验的项目经理给出了他们的解决之道,那就是“代码复查”。
什么是代码复查
代码复查(Code Review),又叫“代码审查”,其基本思想就是,在开发人员编写完自己的代码后,由其他人来复查他写的代码,从而有效地发现代码中存在的缺陷。代码复查的一个基本理论就是,当我们越早发现代码存在的缺陷,我们解决缺陷的代价就越低。代码复查往往分成以下一个方面进行审查:
1)代码风格。在项目开发之初,我们往往会制定一个代码编写的规范,实际上,这个代码规范就包含了整个项目组的代码风格。由于软件开发人员的设计习惯不同,如果不统一代码风格,一个项目中的代码将五花八门,如变量和常量的命名、接口与实现类的注释、何时回车、怎样缩进等等。一个五花八门的设计风格,必将为日后的维护与改进带来困难。我们通过代码复查,一方面督促开发人员按照规范编写代码,另一方面也使开发人员自身形成良好的编程习惯。代码风格的审查,由于内容比较单一,我们常常可以通过一些代码复查的工具来自动完成,提高复查的效率。
2)重大缺陷。在一些关于代码复查的文章中,列出了一个常常的单子,描述了代码复查应当着重注意的重大缺陷,它们包括:存在SQL注入、易受跨站点脚本攻击、缓存区溢出、托管代码等等。项目组可以不断积累重大缺陷的审查项目,并在每次审查中逐一检查。重大缺陷审查是一个繁琐而细致的工作,如果能编写或使用一些审查软件,可以大大提高我们的审查效率。
3)设计逻辑与思路的审查。我认为,这部分的审查是代码复查中最核心、最有价值的部分。代码风格与重大缺陷的审查,虽然重要但简单而机械,可以通过软件自动检查;而设计逻辑与思路的审查,却是复杂而有深度的审查,需要有一定理论深度和编码经验的人才能完成,而且对新手尤其重要。前面提到,新手是任何项目组不可避免的问题。但遗憾的是,许多项目经理的办法是,只将一些简单而少量的工作交给新手完成,而将大量复杂的工作交给人数不多的那些老手来完成。这样的结果是,新手始终是新手,他们没有经过足够的锻炼;老手累死累活,无法指望新手予以分担工作。对于这个问题,我的办法是,通过代码复查,让老手去指导新手,让团队整体素质达到提高。具体办法就是,在新手完成编码以后,让老手去进行代码复查,指出新手的问题,指导新手设计。这样的过程最初可能需要重构,甚至重新编码。但经过这样的过程,新手将逐渐熟练,迅速成为老手,使整体团队素质提高。
代码复查的形式及优缺点
经过以上的描述,我们可以发现代码复查的优点显而易见。首先,通过对代码风格与规范的审查,可以大大提高代码的可读性与可维护性。现在的软件,往往需要持续的维护与升级,人员变动也在所难免,因此代码的可读性与可维护性尤为重要。代码复查是一种鞭策,因为它的存在,督促着开发人员自觉地规范编码,养成好的编码习惯,提高代码质量。一个值得注意的问题是,如果你不去读别人的代码,永远不能深刻理解什么是可读的代码,而自己的代码不让别人去读并且反馈,也永远不知道自己的代码是否可读,即使你是一个编码多年的老手。代码复查恰恰解决了这个问题,值得你去尝试。
其次,代码复查是一次程序员之间的交流。新手可以有更多的机会向老手学习和指导,提高自身的设计水平(应当说这对于他们是非常宝贵的);老手通过对新手的指导,整理和升华自己的设计思路与理论,同时也是对自己另一方面的锻炼与提高。另外,当你发现并指出了别人的一个问题以后,同时也是在警示自己不要犯同样的错误,这对审查与被审查者都是有益的。
虽然代码复查有如此突出的优点,但它的缺点也是非常显著的,那就是它需要付出如此巨大的代价。当一个人完成编码以后,还需要另外的人去解读和审查,并要求编程人员完成相应的修改,甚至重构和重写,这本身就是一种巨大的代价。这对于其本身就已经人员和时间非常紧张的软件开发项目来说,无疑是一种雪上加霜。时间、人力与代码质量,其本身就是鱼和熊掌不可兼得,关键是如何去权衡。正因为如此,不同公司选择了不同的代码复查策略。
前不久,我听了韩国一家大型游戏软件公司谈他们的代码复查。由于这家公司在软件开发时,时间和人力不是最关键和紧要的问题而代码质量,所以他们采用了一种严格的代码复查策略。严格的代码复查策略,一种方式是由专人进行代码复查。这种方式,在人员组织形式上,从软件开发人员中单独提出了一些经验丰富的人,组成一个代码复查小组,专职对其它软件开发小组进行代码复查。这种方式,代码复查小组以第三方的身份去复查各个项目组的代码,可以保证复查的公平公正,但压力无疑是巨大的(想想他们要查看那么多的代码)。
另一种方式,是以一个项目开发小组为单元进行代码互查,即一个人的代码,要为小组所有成员进行审查。这种方式毫无疑问,其付出的代价太大了。对这种方式的一种变通方式是将XP中的结对编程进行结合,然结对编程中的两个人相互进行代码互查。采用结对编程的项目组可以尝试这样方式,遗憾的是目前国内采用结对编程的项目组实在太少了。以上两种代码复查的最大弊病就是责任制,即审查者没有太多的责任去发现被审查者的问题,发现了问题对审查者没有任何好处,反倒与被审查者结怨;相反,审查者没有发现问题也不会担负任何责任。这样的结果就导致了代码复查流于形式:审查者草草审查,各方皆大欢喜,问题依然存在。
综上所述,虽然代码复查优势明显,但以上几种形式都不能为普通的软件开发团队所接受,就此我祭出了我的最佳实践:以小组为单位,组长责任制的代码复查形式。
代码复查的最佳实践
代码复查是有代价的,甚至有时是巨大的,因此代码复查不宜频繁,最好一份代码只审查一次。同时,代码复查者应当对所审查的代码负有责任,即能够大胆地审查并指出被审查者的问题,并要求被审查者限期整改。与此同时,被审查后的代码如果还出现缺陷,审查者应当负有责任。只有满足了以上三个条件,代码复查才能为我们所接受。毫无疑问,项目开发小组的组长来担当此责任是最合适的。
一个项目开发组,根据其功能的划分,可以划分为多个小组,每个小组负责一个子模块。在这样一个小组中,小组长无疑是最有经验的开发人员,由他去负责组织和指导其它成员是合适的。小组成员不要太多,往往是3~5人。小组长不要分配太多的开发任务,他的主要工作是指导和监督小组其它成员进行开发。将他从繁重的开发任务中解脱出来,他可以有更多的精力去指导其他成员的设计,并且复查他们的代码。最终,他要对小组所有成员的代码质量负责,由项目经理或质量管理员进行抽查,检验其整体情况。
如果你只是一个小型项目,人员总共在5人之内,那么你不用这样分组。作为项目经理的你就是那个小组长,指导和监督你的成员。这样安排是因为在现代的管理理论中认为,一个人最多只能管理5个人,超过5个人就应当分组管理。而如果你在5人之内当然就不需要分开啦。
作为组长,你可以有效地审查和管理你的小组成员。同时,由于你负有责任,你也不得不认真有效地去完成审查工作。通过以上的组织形式,代码复查可以简便有效地在项目组中开展起来,从而从管理上有效地提高软件开发的代码质量。
refurl:http://fangang.iteye.com/blog/599976
相关推荐
套路拆解_大厂是如何保证代码质量的!
并从定义并有效度量最影响质量的代码方面、设定质量保证目标并照此规划您的开发过程、 确定哪个代码质量工具和技术可以满足您的需要、 实现最佳实践(清除不好的),使确保代码质量及早并经常地成为开发实践中轻松且...
作者总结自己多年面试他人以及被他人面试的经验,发现应聘者可以从代码的规范性、完整性和健壮性三个方面提高代码的质量。
为了提高软件代码质量,笔者从开发与审核两个过程分析了可以改进代码质量的关键环节,并在此基础上利用AOP提供的连接点模型,提出了一个...实践证明,这些工具可以极大地提高软件的质量和开发效率,并缩短代码质量保证过程。
你的团队有没有过这样的经历:开发效率低,招了很多人,天天加班,...本文就如何保证代码质量总结了一些经验和方法,供大家参考。代码质量本身并没有一个特别明确的量化指标,而且根据公司发展的不同阶段,团队规模的大
终于到了该说说领域驱动设计的时候了。我们在这场关于代码质量的讨论中,...一个比较成功的保证代码质量的管理模式就是代码复查。让一些有经验的程序员定期去复查那些初级程序员的代码,指导他们的开发,被认为是成功的
敏捷开发的理念已经流行了很长的时间,在敏捷开发中的开发迭代阶段中,我们可以通过五个步骤,来有效的提高整个项目的代码质量。 Java项目开发过程中,由于开发人员的经验、Java代码编写习惯,以及缺乏统一的标准和...
然后他会提出您可以尽早并经常地利用覆盖来确保代码质量的三个方法。 您还记得以前大多数开发人员是如何追求代码质量的吗。在那时,有技巧地放置main()方法被视为灵活且适当的测试方法。经历了漫长的道路以后,现在...
CodeCov-Jacoco-Java-Jenkins-Demo 确保代码质量始终保持较高水平的最佳方法之一是监视测试覆盖率。 在这个简短的演示中,我演示了如何在每次使用Jenkins和Codecov进行更改时在Java应用程序中设置JaCoCo并生成代码...
内容概要:本手册旨在为阿里巴巴的Java开发团队提供一套规范和最佳实践,以确保代码质量和项目成功。 适合人群:学习Java的初学者可以参考一下行业内的一些开发准则。 能学到什么:①遵循编码规范,提高代码可读性...
严格地遵守代码规范,是提高且保证代码质量的最有效方法。从个人开发的角度来看,一份良好的代码规范,能够对代码整洁起到指导帮助作用。从多人协作的角度来看,统一的代码规范能够有效减少沟通的阻碍。 □ 逻辑...
两天速成不敢保证代码质量),发现问题就直接指出嘛,不用走流程啦! 环境 首先需要一个python,然后安装opencv的python库,如下: pip install opencv-python 然后测试一下是否可用,如下: import cv2 as cv ...
norm 一个包含 prettier,eslint,stylelint 的配置文件合集,统一美化标准。 使用 在 JavaScript 的 Vue 2.x 项目中的 .eslintrc.js module.exports = { extends: [require.resolve('@fe6/norm/src/eslint/vue2-js...
SonarLint是一个免费的开源IDE扩展,它可以识别并帮助您在编写代码时解决代码质量和代码安全问题。SonarLint类似于拼写检查器,它可以发现一些常见的编码缺陷,并提供实时反馈和提供明确的补救指导,从而优化你编写...
tests: 测试脚本,用于确保代码质量和功能正确性。 ultralytics: YOLOv8 的主要源代码目录。 重要文件: README.md: 提供了项目的基本介绍和使用指南。 LICENSE: 项目的许可证文件,指明了代码的使用条款。 ...
单元测试:单元测试是确保代码质量的重要手段之一。通过编写测试用例并执行测试,可以验证代码的正确性和稳定性。Go语言内置了测试功能,可以通过编写以_test.go结尾的测试文件来执行测试。 集成测试:集成测试是...
铝纤维 一个包含更漂亮,eslint,stylelint的配置文件合集 包含更漂亮,eslint,stylelint的配置文件的集合 利用 在.eslintrc.js module .... extends : [ require .... // in antd-design-pro globals : { ...
能够保证代码质量,包括代码评审、metric、设计模式、测试,等等。 CodePro Analytix是首屈一指的Java软件测试工具Eclipse的开发,提高软件质量和减少发展成本和时间表。Java软件审计工具的功能,使开发商减少错误...
Matlab技术的使用教程、使用方法、使用技巧、使用注意事项、使用中常见问题