高效代码审查的十个经验

代码审查(Code Review)是软件开发中常用的手段,和QA测试相比,它更容易发现和架构以及时序相关等较难发现的问题,还可以帮助团队成员提高编程技能,统一编程风格等。

  1. 代码审查要求团队有良好的文化

  团队需要认识到代码审查是为了提高整个团队的能力,而不是针对个体设置的检查“关卡”。

  “A的代码有个bug被B发现,所以A能力不行,B能力更好”,这一类的陷阱很容易被扩散从而影响团队内部的协作,因此需要避免。

  另外,代码审查本身可以提高开发者的能力,让其从自身犯过的错误中学习,从他人的思路中学习。如果开发者对这个流程有抵触或者反感,这个目的就达不到。

  2. 谨慎的使用审查中问题的发现率作为考评标准

  在代码审查中如果发现问题,对于问题的发现者来说这是好事,应该予以鼓励。但对于被发现者,我们不主张使用这个方式予以惩罚。软件开发中bug在所难免,过度苛求本身有悖常理。更糟的是,如果造成参与者怕承担责任,不愿意在审查中指出问题,代码审查就没有任何的价值和意义。

  3. 控制每次审查的代码数量

  根据smartbear在思科所作的调查,每次审查200行-400行的代码效果最好。每次试图审查的代码过多,发现问题的能力就会下降,具体的比例关系如下图所示:

  我们在实践中发现,随着开发平台和开发语言的不同,最优的代码审查量有所不同。但是限制每次审查的数量确实非常必要,因为这个过程是高强度的脑力密集型活动。时间一长,代码在审查者眼里只是字母,无任何逻辑联系,自然不会有太多的产出。

  4. 带着问题去进行审查

  我们在每次代码审查中,要求审查者利用自身的经验先思考可能会碰到的问题,然后通过审查工作验证这些问题是否已经解决。一个窍门是,从用户可见的功能出发,假设一个比较复杂的使用场景,在代码阅读中验证这个使用场景是否能够正确工作。

  使用这个技巧,可以让审查者有代入感,真正的沉浸入代码中,提高效率。大家都知道看武侠小说不容易瞌睡,而看专业书容易瞌睡,原因就是武侠小说更容易产生代入感。

  有的研究建议每次树立目标,控制单位时间内审核的代码数量。这个方法在我们的实践中显得很机械和流程化,不如上面的方法效果好。

  5. 所有的问题和修改,必须由原作者进行确认

  如果在审查中发现问题,务必由原作者进行确认。

  这样做有两个目的:

  (1)确认问题确实存在,保证问题被解决

  (2)让原作者了解问题和不足,帮助其成长

  有些时候为了追求效率,有经验的审查者更倾向于直接修改代码乃至重构所有代码,但这样不利于提高团队效率,并且会增加因为重构引入新bug的几率,通常情况下我们不予鼓励。

  6.利用代码审查激活个体“能动性"

  即使项目进度比较紧张,无法完全的进行代码审查,至少也要进行部分代码的审查,此时随即抽取一些关键部分是个不错的办法。

  背后的逻辑是,软件开发是非常有创造性的工作,开发者都有强烈的自我驱动性和自我实现的要求。让开发者知道他写的任何代码都可能被其他人阅读和审察,可以促使开发者集中注意力,尤其是避免将质量糟糕,乃至有低级错误的代码提交给同伴审查。开源软件也很好的利用了这种心态来提高代码质量。

  7.在非正式,轻松的环境下进行代码审查

  如前所述,代码审查是一个脑力密集型的工作。参与者需要在比较轻松的环境下进行该工作。因此,我们认为像某些实践中建议的那样,以会议的形式进行代码审查效果并不好,不仅因为长时间的会议容易让效率低下,更因为会议上可能出现的争议和思考不利于进行如此复杂的工作。

  8.提交代码前自我审查,添加对代码的说明

  所有团队成员在提交代码给其他成员审查前,必须先进行一次审查。这次自我修正形式的审查除了检查代码的正确性以外,还可以完成如下的工作:

  (1)对代码添加注释,说明本次修改背后的原因,方便其他人进行审查。

  (2)修正编码风格,尤其是一些关键数据结构和方法的命名,提高代码的可读性。

  (3)从全局审视设计,是否完整的考虑了所有情景。在实现之前做的设计如果存在考虑不周的情况,这个阶段可以很好的进行补救。

  我们在实践中发现,即使只有原作者进行代码审查,仍然可以很好的提高代码质量。

  9.实现中记录笔记可以很好的提高问题发现率

  成员在编码的时候应做随手记录,包括在代码中用注释的方式表示,或者记录简单的个人文档,这样做有几个好处:

  (1)避免遗漏。在编码时将考虑到的任何问题都记录下来,在审查阶段再次检查这些问题都确认解决。

  (2)根据研究,每个人都习惯犯一些重复性的错误。这类问题在编码是记录下来,可以在审查的时候用作检查的依据。

  (3)在反复记录笔记并在审查中发现类似的问题后,该类问题出现率会显著下降

  10. 使用好的工具进行轻量级的代码审查

  “工欲善其事,必先利其器”。我们使用的是bitbucket提供的代码托管服务。

  每个团队成员独立开发功能,然后利用Pull Request的形式将代码提交给审查者。复审者可以很方便在网页上阅读代码,添加评论等,然后原作者会自动收到邮件提醒,对审阅的意见进行讨论。

  即使团队成员分布在天南海北,利用bitbucket提供的工具也能很好的进行代码审查。

时间: 2024-10-10 00:24:31

高效代码审查的十个经验的相关文章

高效代码审查的十条经验读后感

<高效代码复审的是个经验>读后感 其实看完这十条经验之后,对我还是深有体会的,因为目前我们在进行双人项目和团队项目,那么代码就不再只是下一个人的,由多人完成,所以在团队中,代码复审是很重要的,我记得以前在其他书上看到过一句话可悲的是,对于很多学生.自由职业者以及机构来说,代码审查似乎相当陌生. 很明显,代码审查的重要性并不为每个人所熟知.你可以说我很天真,但是笔者确实认为所有的IT公司都离不开该过程.显然实际并非如此,真是让我大吃一惊.可见复审对于一个公司的团队来说多么重要.可悲的是,我们很多

代码审查 本地测试经验汇总

软件测试虽然辛苦,但是掌握了一定的技巧之后将使你事半功倍. (1) 边界测试,测试用户输入框中的数值的最大数和最小数,以及为空时的情况. (2) 非法测试,例如在输入数字的地方输入字母. (3) 跟踪测试,跟踪一条数据的流程,保证数据的正确性. (4) 在开始测试时应保证数据的正确性,然后在从系统中找出各种BUG. (5) 接口测试,程序往往在接口的地方很容易发生错误,要在此模块测试勿掉以轻心. (6) 代码重用测试,在开发过程中有些模块功能几乎相同,程序员在重用代码时可能忘记在原有代码上修改或

未来酒店——建设高效研发团队的经验分享

摘要: 在5月29日召开的第二届研发效能嘉年华中,由浙江未来酒店网络技术有限公司的孙吉君带来了"未来酒店--建设高效研发团队的经验分享".本次分享中他对未来酒店研发规模进行了介绍,对高效团队的三个特征.四个能力的培养和团队建设过程中的四个方法进行了讲解. 在5月29日召开的第二届研发效能嘉年华中,由浙江未来酒店网络技术有限公司的孙吉君带来了"未来酒店--建设高效研发团队的经验分享".本次分享中他对未来酒店研发规模进行了介绍,对高效团队的三个特征.四个能力的培养和团队

代码审查时,发现功能实现的原因,而不仅仅是挑毛病(转)

对于很多公司来说,代码审查是开发人员日常工作中的重要环节.通过代码审查,可以及早发现项目中存在的问题.促进同事之间的沟通与交流,并且可以在讨论中迸发出智慧的火花.但要想成功实施代码审查却并不是一件轻松的事情,为什么要进行代码审查.何时做.如何做,这是摆在我们面前的3个重要问题.针对于这3个问题,开发者Lisa Tjapkes撰文谈到了自己的经验与教训. 在我最近的项目经历中,我们进行了广泛且正式的代码审查.这个过程极大地改进了项目的代码质量,降低了项目中新特性开发的等待时间,同时还促进了知识在整

代码审查总结

最近所带项目,因为人员素质良莠不齐,写出的代码质量不一,为了保证项目质量,不得不对代码一行行进行审查.同时,为了对代码审查有个更深的了解及借鉴其它同行实践成果,在网上搜集了不少项目知识,下面是对这些知识做出的整理. 第1章前提 在 Wikipedia 上,对代码审查的定义是:代码审查(英语:Code Review)是指对计算机源代码系统化地审查,常用软件同行评审的方式进行,其目的是在找出及修正在软件开发初期未发现的错误,提升软件质量及开发者的技术.代码审查常以不同的形式进行,例如结对编程.非正式

程序员必备的代码审查(Code Review)清单【转载】

在我们关于高效代码审查的博文中,我们建议使用一个检查清单.在代码审查中,检查清单是一个非常好的工具——它们保证了审查可以在你的团队中始终如一的进行.它们也是一种保证常见问题能够被发现并被解决的便利方式. 软件工程学院的研究表明,程序员们会犯15-20种常见的错误.所以,通过把这些错误加入到检查清单当中,你可以确保不论什么时候,只要这些错误发生了,你就能发现它们,并且可以帮助你杜绝这些错误. 为了帮助你开始创建一个清单,这里列出了一些典型的内容: 代码审查清单 常规项 代码能够工作么?它有没有实现

程序员必备的代码审查(Code Review)清单

在我们关于高效代码审查的博文中,我们建议使用一个检查清单.在代码审查中,检查清单是一个非常好的工具--它们保证了审查可以在你的团队中始终如一的进行.它们也是一种保证常见问题能够被发现并被解决的便利方式. 软件工程学院的研究表明,程序员们会犯15-20种常见的错误.所以,通过把这些错误加入到检查清单当中,你可以确保不论什么时候,只要这些错误发生了,你就能发现它们,并且可以帮助你杜绝这些错误. 为了帮助你开始创建一个清单,这里列出了一些典型的内容: 代码审查清单 常规项 代码能够工作么?它有没有实现

2015第32周四

团队成员的沟通只限于"业务沟通".大家只忙着干活,项目经理和成员之间,成员和成员之间,都只谈工作上的事情.除此之外的交流,都好像搞运动,完成任务,推一下就动一下,不推就停止了. 明眼人都知道,这样的状态是不对的,长远来看,工作效率是上不来的.工作,尤其是创造性工作,其中是有大量不确定的模糊地带的,需要大家具体协商解决,而不能依靠刚性的制度来事先规定.虽然沟通的问题是工作问题,但离不开工作之外的关系.情商等等"软实力".否则,日常的协作很容易变成公事公办,大家的分工也

高科影像金属照片何雯娜

照片可以反击虚假是人们最珍贵的物品之一,高创影像金属照片,因为照片可以留住人们的青春,商丘金属照片,金生缘,留住人们的记忆.普通的照片可能会因为某些原因而破坏,金属照片克服了传统纸质照片的易褪色,易受潮,高科影像金属照片,保存时间短等弊端. 商丘金属照片加盟引领时尚创造未来,自面世以来,凭借特立独行的产品气质迅速火爆市场,更是受到众多投资创业者的青睐!金属照片加盟五大优势成就梦想! 金属照片加盟操作便捷 公司研发的金属照片专用设备操作简单低能高效,无需任何经验和美术基础.2天培训即可快速上手,商