坚果云开发团队分享高效代码审查经验
代码审查是软件开发中常用的手段,坚果云开发团队最近在“月光博客”上撰文分享了高效代码审查的十个经验。和QA测试相比,代码审查更容易发现和架构以及时序相关等较难发现的问题,还可以帮助团队成员提高编程技能,统一编程风格等。
代码审查首先要求团队有良好的文化,同时谨慎的使用审查中问题的发现率作为考评标准:
团队需要认识到代码审查是为了提高整个团队的能力,而不是针对个体设置的检查“关卡”。“A的代码有个bug被B发现,所以A能力不行,B能力更好”,这一类的陷阱很容易被扩散从而影响团队内部的协作,因此需要避免。另外,代码审查本身可以提高开发者的能力,让其从自身犯过的错误中学习,从他人的思路中学习。如果开发者对这个流程有抵触或者反感,这个目的就达不到。
在代码审查中如果发现问题,对于问题的发现者来说这是好事,应该予以鼓励。但对于被发现者,我们不主张使用这个方式予以惩罚。软件开发中bug在所难免,过度苛求本身有悖常理。更糟的是,如果造成参与者怕承担责任,不愿意在审查中指出问题,代码审查就没有任何的价值和意义。
关于代码审查的数量问题,坚果云团队认为要灵活的根据开发平台或者语言控制每次审查的代码规模:
根据smartbear在思科所作的调查,每次审查200行-400行的代码效果最好。每次试图审查的代码过多,发现问题的能力就会下降。我们在实践中发现,随着开发平台和开发语言的不同,最优的代码审查量有所不同。但是限制每次审查的数量确实非常必要,因为这个过程是高强度的脑力密集型活动。时间一长,代码在审查者眼里只是字母,无任何逻辑联系,自然不会有太多的产出。
代码审查需要带着问题去做,并且让原作者对发现的问题进行确认:
我们在每次代码审查中,要求审查者利用自身的经验先思考可能会碰到的问题,然后通过审查工作验证这些问题是否已经解决。一个窍门是,从用户可见的功能出发,假设一个比较复杂的使用场景,在代码阅读中验证这个使用场景是否能够正确工作。使用这个技巧,可以让审查者有代入感,真正的沉浸入代码中,提高效率。大家都知道看武侠小说不容易瞌睡,而看专业书容易瞌睡,原因就是武侠小说更容易产生代入感。有的研究建议每次树立目标,控制单位时间内审核的代码数量。这个方法在我们的实践中显得很机械和流程化,不如上面的方法效果好。
如果在审查中发现问题,务必由原作者进行确认。这样做有两个目的:
- 确认问题确实存在,保证问题被解决
- 让原作者了解问题和不足,帮助其成长
有些时候为了追求效率,有经验的审查者更倾向于直接修改代码乃至重构所有代码,但这样不利于提高团队效率,并且会增加因为重构引入新bug的几率,通常情况下我们不予鼓励。
利用代码审查激活个体“能动性”:
即使项目进度比较紧张,无法完全的进行代码审查,至少也要进行部分代码的审查,此时随即抽取一些关键部分是个不错的办法。背后的逻辑是,软件开发是非常有创造性的工作,开发者都有强烈的自我驱动性和自我实现的要求。让开发者知道他写的任何代码都可能被其他人阅读和审察,可以促使开发者集中注意力,尤其是避免将质量糟糕,乃至有低级错误的代码提交给同伴审查。开源软件也很好的利用了这种心态来提高代码质量。
代码审查需要轻松的、非正式的环境:
如前所述,代码审查是一个脑力密集型的工作。参与者需要在比较轻松的环境下进行该工作。因此,我们认为像某些实践中建议的那样,以会议的形式进行代码审查效果并不好,不仅因为长时间的会议容易让效率低下,更因为会议上可能出现的争议和思考不利于进行如此复杂的工作。
除了他人审查,自我审查也有良好的效果:
所有团队成员在提交代码给其他成员审查前,必须先进行一次审查。这次自我修正形式的审查除了检查代码的正确性以外,还可以完成如下的工作:
- 对代码添加注释,说明本次修改背后的原因,方便其他人进行审查。
- 修正编码风格,尤其是一些关键数据结构和方法的命名,提高代码的可读性。
- 从全局审视设计,是否完整的考虑了所有情景。在实现之前做的设计如果存在考虑不周的情况,这个阶段可以很好的进行补救。
我们在实践中发现,即使只有原作者进行代码审查,仍然可以很好的提高代码质量。
代码审查结束后的回顾总结也是非常重要的:
成员在编码的时候应做随手记录,包括在代码中用注释的方式表示,或者记录简单的个人文档,这样做有几个好处:
- 避免遗漏。在编码时将考虑到的任何问题都记录下来,在审查阶段再次检查这些问题都确认解决。
- 根据研究,每个人都习惯犯一些重复性的错误。这类问题在编码是记录下来,可以在审查的时候用作检查的依据。
- 在反复记录笔记并在审查中发现类似的问题后,该类问题出现率会显著下降。
最后,坚果云团队建议“使用好的工具进行轻量级的代码审查”:
“工欲善其事,必先利其器”。我们使用的是bitbucket提供的代码托管服务。每个团队成员独立开发功能,然后利用Pull Request的形式将代码提交给审查者。复审者可以很方便在网页上阅读代码,添加评论等,然后原作者会自动收到邮件提醒,对审阅的意见进行讨论。即使团队成员分布在天南海北,利用bitbucket提供的工具也能很好的进行代码审查。
读者朋友对代码审查工作有什么经验和建议?欢迎发表自己的看法。
转载于:https://www.cnblogs.com/shihao/archive/2012/11/12/2766980.html
坚果云开发团队分享高效代码审查经验相关推荐
- 小程序中里的bindinput_云开发实战分享|诗和远方:旅行小账本云开发
原创:豪豪 前言 最近沉迷小程序开发,发现了一款功能.界面.体验俱佳的小程序"旅行小账本".着手做了个简约版--"旅行小账本".效果比较满意,毕竟前后台一人单干 ...
- 探索图文处理的未来:知名学府与合合信息团队分享NLP实践经验,人工智能引领技术革新
相信最近很多朋友关注的公众号和短视频号都有关于ChatGPT的文章或者视频,对此我就不再过多描述"生成式人工智能"是促成ChatGPT落地的重要技术,"ChatGPT之父 ...
- 企业开发团队分享,BEM 代码命名规范实践
背景 最近老大在维护别人的代码时,发现我们团队写的样式各有种的想法及风格,这在后续维护会增加一定的难度,所以老大决定统一样式的会名规范,所以就安排我去调研及实践,下面是我调研的结果. 什么是 BEM ...
- 云开发版高效学习微信小程序源码包含复习资料学习共享护眼精灵等功能
☑️ 编号:X0016 ☑️ 品牌:暂无 ☑️ 语言:微信小程序 ☑️ 数据库:无需数据库 ☑️ 类型:微信小程序 ☑️ 规格:小程序 ※ 欢迎关注私信(发消息不限制),领取福利 ※ ☑️ 源码介绍: ...
- 微软开发团队的DevOps实践启示
过去几年,微软的工程师团队已经接受了DevOps的工作方式,本文讲述我们在这个过程中积累的经验. \\ 纵观整个软件产业,坦白地说,从我们一路的经验来看,DevOps的实践和方式对于服务和其它产品的交 ...
- share extension 不显示_这几项超好用的云开发扩展能力,别说你还不知道!
云开发CloudBase是云开发团队为开发者提供的一站式云服务,旨在降低开发者使用云服务的门槛,助力开发者快速开发应用.在具体的开发过程中,云开发提供了许多实用的扩展能力,包含图像标签.图像安全审核. ...
- 云开发如何帮助业务扛过大流量活动洪峰丨深度好文
在企业里,做活动是一种十分常见的需求,有面向C端用户开展的活动,也有面向公司内部员工的活动.随着互联网技术的不断发展和疫情等方面的原因,线上开展的活动也越来越多,常见的形式有:内容征集.评论弹幕.点赞 ...
- base64 不一致_这几项超好用的云开发扩展能力,别说你还不知道!
云开发CloudBase是云开发团队为开发者提供的一站式云服务,旨在降低开发者使用云服务的门槛,助力开发者快速开发应用.在具体的开发过程中,云开发提供了许多实用的扩展能力,包含图像标签.图像安全审核. ...
- 云开发数据库VS传统数据库丨云开发101
云开发数据库与传统数据库的不同 在小程序·云开发中,最核心的便是三大组件:数据库.云存储和云函数,从今天开始,我们将开始隔日更的专栏文章,云开发101,在第一周,我们将从最最核心的数据库开始说起. 云 ...
最新文章
- linux进程管理机制,linux进程管理,linux进程管理机制
- PHP数组的交集array_intersect(),array_intersect_assoc(),array_inter_key()函数详解
- Android重要组件之一 Service 服务讲解学习(一)
- vb 用代码添加控件
- WCF完美搭建android平台服务之一
- 王爽《汇编语言(第三版)》检测点11.1
- (网页)Uncaught ReferenceError: pageImport is not defined
- Linux命令之find命令中的-mtime参数
- 【英语之夜】遇见--Peter
- 你知道怎么离线安装全局 node 模块吗?
- python在哪里写代码-程序员面试被要求手写代码,你与顶级程序员的差别在哪?...
- MPLS/×××网络解决MTU问题方法
- python random 之基础点名器
- 浙江计算机三级在线试题及答案,计算机三级试题及答案
- OpenCV 安装配置 Jupyter Notebook
- 最基础的python语法
- XShell4 SSH服务器拒绝了密码解决办法
- 最全的软件测试面试题(含答案)
- 51单片机开关简单使用
- Android Studio 配置翻译工具
热门文章
- 耳目一新的在线答疑服务背后的核心技术
- mysql主从备份及原理分析
- Virtual Machine Manager 2012 R2利用服务模板部署DC
- centos mysql 主从配置_centos7.4安装mysql8,并设置主从配置
- pythonfor久久_python 九九乘法表 for循环
- mysql sql优化_MySQL优化SQL语句的步骤
- JavaScript字符串方法——持续补充
- nginx之lua_shared_dict
- linux嵌入式物联网_嵌入式Linux如何加速物联网发展
- opensource项目_最佳Opensource.com:法律