深入浅出,Code Review 最佳实践

【知识整理】简述 Code Review - 代码审查 这种场景,其实是一次性囤的代码太多导致的,很多同学觉得,我应该把一个功能完整的开发完毕,再提上去,大家才知道我在写什么,但是实际上,coding 是个循序渐进的过程,建议日常开发的同学控制 commit 粒度,尽可能保证每天提交,以及尽可能写好 commit message,还有就是 commit 跟卡片做好关联,也有助于 reviewer 能更好的理解你的意图。作为一个认真负责的你,当然是满口答应,准备点进去看看,过了一秒钟打开GIT网页,发现 365 个文件变更,此时求你的心里阴影面积。 阅读详情

点击上方“芋道源码”,选择“设为星标”

做积极的人,而不是积极废人!

源码精品专栏

 

来源:http://rrd.me/emHuu

  • Code Review有什么好处?

    • 首先是团队知识共享的角度

    • 然后是代码质量的角度

    • 还有团队规范的角度

  • 该怎么做?

    • 把Code Review作为开发流程的必选项而不是可选项

    • 把Code Review变成一种开发文化而不仅仅是一种制度

  • 一些Code Review的经验技巧

    • 选什么工具辅助做CODE REVIEW?

    • 配合什么样的开发流程比较好?

  • 真遇到紧急情况,来不及代码审查怎么办?

    • 先设计再编码

    • 代码在提交CODE REVIEW之前,作者要自己先REVIEW和测试一遍

    • PR要小

    • 对评论进行分级

    • 评论要友好,避免负面词汇;有说不清楚的问题当面沟通

  • 总结


我一直认为Code Review(代码审查)是软件开发中的最佳实践之一,可以有效提高整体代码质量,及时发现代码中可能存在的问题。包括像Google、微软这些公司,Code Review都是基本要求,代码合并之前必须要有人审查通过才行。

然而对于我观察到的大部分软件开发团队来说,认真做Code Review的很少,有的流于形式,有的可能根本就没有Code Review的环节,代码质量只依赖于事后的测试。也有些团队想做好代码审查,但不知道怎么做比较好。

网上关于如何做Code Review的文章已经有很多了,这里我结合、自己的一些经验,也总结整理了一下Code Review的最佳实践,希望能对大家做好Code Review有所帮助。

Code Review有什么好处?

很多团队或个人不做Code Review,根源还是不觉得这是一件有意义的事情,不觉得有什么好处。这个问题要从几个角度来看。

首先是团队知识共享的角度

一个开发团队中,水平有高有低,每个人侧重的领域也有不同。怎么让高水平的帮助新人成长?怎么让大家都对自己侧重领域之外的知识保持了解?怎么能有人离职后其他人能快速接手?这些都是团队管理者关心的问题。

而代码审查,就是一个很好的知识共享的方式。通过代码审查,高手可以直接指出新手代码中的问题,新手可以马上从高手的反馈中学习到好的实践,得到更快的成长;通过代码审查,前端也可以去学习后端的代码,做功能模块A的可以去了解功能模块B的。

可能有些高手觉得给新手代码审查浪费时间,自己也没收获。其实不然,新人成长了,就可以更多的帮高手分担繁重的任务;代码审查中花时间,就少一些帮新人填坑擦屁股的时间;良好的沟通能力、发现问题的能力、帮助其他人成长,都是技术转管理或技术上更上一层楼必不可少的能力,而通过代码审查可以有效的去练习这些方面的能力。

然后是代码质量的角度

现实中的项目总是人手缺进度紧,所以被压缩的往往就是自动化测试和代码审查,结果影响代码质量,欠下技术债务,最后还是要加倍偿还。

也有人寄希望于开发后的人工测试,然而对于代码质量来说,很多问题通过测试是测试不出来的,只能通过代码审查。比如说代码的可读性可维护性,比如代码的结构,比如一些特定条件才触发的死循环、逻辑算法错误,还有一些安全上的漏洞也更容易通过代码审查发现和预防。

也有人觉得自己水平高就不需要代码审查了。对于高手来说,让别人审查自己的代码,可以让其他人学习到好的实践;在让其他人审查的同时,在给别人说明自己代码的时候,也等于自己对自己的代码进行了一次审查。这其实就跟我们上学时做数学题一样,真正能拿高分的往往是那些做完后还会认真检查的。

还有团队规范的角度

每个团队都有自己的代码规范,有自己的基于架构设计的开发规范,然而时间一长,就会发现代码中出现很多不遵守代码规范的情况,有很多绕过架构设计的代码。比如难以理解和不规范的命名,比如三层架构里面UI层绕过业务逻辑层直接调用数据访问层代码。

如果这些违反规范的代码被纠正的晚了,后面再要修改就成本很高了,而且团队的规范也会慢慢的形同虚设。

通过代码审查,就可以及时的去发现和纠正这些问题,保证团队规范的执行。

关于代码审查的好处,还有很多,也不一一列举。还是希望能认识到Code Review和写自动化测试一样,都是属于磨刀不误砍柴工的工作,在上面投入一点点时间,未来会收获代码质量,会节约整体的开发时间。

该怎么做?

现在很多人都已经有意识到Code Review的重要性了,只是苦于不知道如何去实践,不知道怎么样算是好的Code Review实践。

把Code Review作为开发流程的必选项而不是可选项

在很早以前,我就尝试过将代码审查作为代码流程的一部分,但只是一个可选项,没有Code Review也可以把代码合并到master。这样的结果就是想起来才会去做Code Review,去检查的时候已经有了太多的代码变更,审查起来非常困难,另外就算审查出问题,也很难得以修改。

我们现在对代码的审查则是作为开发流程的一个必选项,每次开发新功能或者修复Bug,开一个新的分支,分支要合并到master有两个必要条件:

  • 所有的自动化测试通过

  • 有至少一个人Code Review通过,如果是新手的PR,还必须有资深程序员Code Review通过

img

图片来源:How to Do Code Reviews Like a Human

这样把Code Review作为开发流程的一个必选项后,就很好的保证了代码在合并之前有过Code Review。而且这样合并前要求代码审查的流程,好处也很明显:

  • 由于每一次合并前都要做代码审查,这样一般一次审查的代码量也不会太大,对于审查者来说压力也不会太大

  • 如果在Code Review时发现问题,被审查者希望代码能尽快合并,也会积极的对审查出来的问题进行修改,不至于对审查结果太过抵触

如果你觉得Code Review难以推行,不妨先尝试着把Code Review变成你开发流程的一个必选项。

把Code Review变成一种开发文化而不仅仅是一种制度

把Code Review 作为开发流程的必选项后,不代表Code Review这件事就可以执行的很好,因为Code Review 的执行,很大部分程度上依赖于审查者的认真审查,以及被审查者的积极配合,两者缺一不可!

如果仅仅只是当作一个流程制度,那么就可能会流于形式。最终结果就是看起来有Code Review,但没有人认真审查,随便看下就通过了,或者发现问题也不愿意修改。

真要把Code Review这件事做好,必须让Code Review变成团队的一种文化,开发人员从心底接受这件事,并认真执行这件事。

要形成这样的文化,不那么容易,也没有想象的那么难,比如这些方面可以参考:

  • 首先,得让开发人员认识到Code Review这件事为自己、为团队带来的好处

  • 然后,得要有几个人做好表率作用,榜样的力量很重要

  • 还有,对于管理者来说,你激励什么,往往就会得到什么

  • 最后,像写自动化测试一样,把Code Review要作为开发任务的一部分,给审查者和被审查者都留出专门的时间去做这件事,不能光想着马儿跑得快又舍不得给马儿吃草

如何形成这样的文化,有心的话,还有很多方法可以尝试。只有真正让大家都认同和践行,才可能去做好Code Review这件事。

一些Code Review的经验技巧

在做好Code Review这件事上,还有一些经验技巧可以参考。

选什么工具辅助做CODE REVIEW?

现在很多源代码管理工具都自带Code Review工具,典型的像Github、Gitlab、微软的Azure DevOps,尤其是像Gitlab,还可以自己在本地搭建环境,根据自己的需要灵活配置。

配合什么样的开发流程比较好?

像Github Flow这样基于分支开发的流程是特别适合搭配Code Review的。其实不管什么样的开发流程,关键点在于代码合并到master(主干)之前,要先做Code Review。

真遇到紧急情况,来不及代码审查怎么办?

虽然原则上,必须要Code Review才能合并,但有时候确实会存在一些紧急情况,比如说线上故障补丁,而又没有其他人在线,那么这种情况下,最好是在任务管理系统中,创建一个Ticket,用来后续跟踪,确保后续补上Code Review,并对Code Review结果有后续的代码更新。

先设计再编码

有些新人发现自己的代码提交PR(Pull Request)后,会收到一堆的Code Review意见,必须要做大量的改动。这多半是因为在开始做之前,没有做好设计,做出来后才发现问题很多。

建议在做一个新功能之前,写一个简单的设计文档,表达清楚自己的设计思路,找资深的先帮你做一下设计的审查,发现设计上的问题。设计上没问题了,再着手开发,那么到Review的时候,相对问题就会少很多。

代码在提交CODE REVIEW之前,作者要自己先REVIEW和测试一遍

我在做代码审查的时候,有时候会发现一些非常明显的问题,有些甚至自己都没有测试过,就等着别人Code Review和测试帮助发现问题。这种依赖心理无论是对自己还是对团队都是很不负责任的。

一个好的开发人员,代码在提交Code Review之前,肯定是要自己先Review一遍,把该写的自动化测试代码写上,自己把基本的测试用例跑一遍的。

我对于团队提交的PR,有个要求就是要在PR的描述中增加截图或者录屏,就是为了通过截图或者录屏,确保提交PR的人自己是先测试过的。这也是一个有效的辅助手段。

PR要小

在做Code Review的时候,如果有大量的文件修改,那么Review起来是很困难的,但如果PR比较小,相对就比较容易Review,也容易发现代码中可能存在的问题。

所以在提交PR时,PR要小,如果是比较大的改动,那么最好分批提交,以减轻审查者的压力。

img

对评论进行分级

在做Code Review时,需要针对审查出有问题的代码行添加评论,如果只是评论,有时候对于被审查者比较难甄别评论所代表的含义,是不是必须要修改。

建议可以对Review的评论进行分级,不同级别的结果可以打上不同的Tag,比如说:

  • [blocker]: 在评论前面加上一个blocker标记,表示这个代码行的问题必须要修改

  • [optional]:在评论前面加上一个[optional]标记,表示这个代码行的问题可改可不改

  • [question]:在评论前面加上一个[question]标记,表示对这个代码行不理解,有问题需要问,被审查者需要针对问题进行回复澄清

类似这样的分级可以帮助被审查者直观了解Review结果,提高Review效率。

评论要友好,避免负面词汇;有说不清楚的问题当面沟通

虽然评论是主要的Code Review沟通方式,但也不要过于依赖,有时候面对面的沟通效率更高,也容易消除误解。

另外文明用语,不要用一些负面的词汇。

总结

Code Review是一种非常好的开发实践,如果你还没开始,不妨逐步实践起来;如果已经做了效果不好,不妨对照一下,看有没有把Code Review作为开发流程的必选项而不是可选项?有没有把Code Review变成一种开发文化而不仅仅是一种制度?



欢迎加入我的知识星球,一起探讨架构,交流源码。加入方式,长按下方二维码噢:

已在知识星球更新源码解析如下:


如果你喜欢这篇文章,喜欢,转发。

生活很美好,明天见(。・ω・。)ノ♡

代码评审(Code Review)规范 Code Review由项目负责人发起,一个项目过程中至少2-3次,主要集中在项目中后期,如果项目规模较大,功能较多,时间比较宽裕,也可适当增加。1、大型项目,增加/修改超过10个文件或超过500行代码的,需组织CodeReview会议,邀请相关同事及高阶同事参与代码Review。2、小型项目,小需求修改(少于10个文件变更或少于500行代码的),至少需要1~2位同事帮忙进行代码Review并提出点评建议。代码的一致性、编码风格、代码的安全问题、脱敏问题、代码冗余、是否正确设计以符。 阅读详情

相关推荐

CodeReview效率提升工具:CodeReview Intellij IDEA插件

介绍了本人开发的Intellij IDE插件CodeReviewRecorder,提升Code Review问题的记录效率和方便问题的闭环跟踪。

每天学习一点点,每天记录一点点 1万+

什么是代码评审(Code Review)

Code Review(CR)即代码评审,又名代码走查,是一种通过复查代码来提高代码质量的过程,一般体现在一个团队的开发过程中。CR要求团队成员有意识地、系统地检查彼此的代码,从而验证需求、发现错误,同时指出其中不合规范的“低质量”代码,从而提高整个团队的代码质量。一次 CR 可以是一次 Commit,也可以是一次 Merge Request。因此,实践课系统支持团队内部的 MR 评审以及 Commit 评审,供大家学习和交流。...

qq_39249627的博客 5万+

Code Review 指导方针

一份好的MR描述不仅对团队的工作和代码质量有重要作用,也是对自己的工作的一个review的过程。1、如果MR中有部分代码超出了需求范围,但可以改善线上系统的整体代码健康状况(例如在不影响功能的情况下优化了代码结构,或提升了原有代码的性能),即使这部分改动并不完美,Review 也要倾向于批准和鼓励这些改动。1、在风格问题上,团队的编码规范具有绝对的权威,规范中未提及的点都算是个人喜好问题,优先保持和工程中其余代码风格一致,否则,除非可以显著增加可读性或可维护性,请尝试接受作者的代码风格。

程序猿进阶 1万+

腾讯 Code Review 规范出炉!

点击“开发者技术前线”,选择“星标????”在看|星标|留言, 真爱作者:cheaterlin,腾讯 PCG 后台开发工程师 来自:腾讯技术工程前言作为公司代码委员会 golang 分...

开发者技术前线-DevolperFront 5771

团队的Code Review实践

Code Review 的好处虽然被广泛认可,但想做好 Code Review 并不容易。首先团队需要对开展 Code Review 达成共识,然后针对自己团队的特性,采用相匹配的实践方式。关于工具,可以尝试文中提到的 Code Review 插件以及电子看板。在提升自动化程度的同时,积累 Code Review 数据,指导团队针对性地提升技能。

IDEAL Garden 5031

从零开始Code Review

从零开始Code Review这篇帖子不是介绍Code Review的方法论, 而是记录了我们团队怎么从没有这个习惯到每天都进行review的过程. 希望能对诸位的团队有所帮助. 最初来到这个新组建的团队是木有code review的. 头说, 这个月你来搞吧.当我第一次知道必须得搞review的时候, 其实我是拒绝的! 因为我觉得…呀…你不能叫我马上搞立马搞, 第一,

晓月的专栏 2万+

Code Review最佳实践

因为最近在工作上参与制定了团队的一些Code Review(CR)的规范,所以想在这里给大家分享一下我们积累的一些CR最佳实践。本篇文章会包括下面这些内容: 为什么需要Code Review 什么时候做Code Review Committer需要注意什么 Code Reviewer需要看哪方面的内容 为什么需要Code Review 对于参与人数大于或者等于两个的项目来说,CR是一项必不可少的活动。在我看来它有下面这些好处: 可以提高committer对于自己代码的要求 按照我以往的经验来说,有些人的

weixin_39305620的博客 927

Google: 如何做code review?

导语:Google 前几天公开了一篇谷歌的工程实践文档,内容跟 code review 相关,里面包含了 Google 工程师如何进行 code review 的内容,以及 code review 指南。笔者将其转译成中文,以便大家参考学习。 原文地址:https://google.github.io/eng-practices/review/reviewer 本文的名词解释: c...

给我一点温度 9331

不容错过, Code Review 的最佳实践方案来了

面试题集可以帮助你查漏补缺,有方向有针对性的学习,为之后进大厂做准备。但是如果你仅仅是看一遍,而不去学习和深究。那么这份面试题对你的帮助会很有限。最终还是要靠资深技术水平说话。网上学习 Android的资料一大堆,但如果学到的知识不成体系,遇到问题时只是浅尝辄止,不再深入研究,那么很难做到真正的技术提升。建议先制定学习计划,根据学习计划把知识点关联起来,形成一个系统化的知识体系。学习方向很容易规划,但是如果只通过碎片化的学习,对自己的提升是很慢的。

2401_84132423的博客 807

HOW - 建立高效、可持续的团队 Code Review 机制

建立一个高效、可持续的 Code Review 机制是前端团队成长的重要一环。以下是一个实际可落地的方案,涵盖。

weixin_58540586的博客 1311

基于GitLab的Code Review教程

一、前言 1、本文主要内容 GitLab Code Review机制说明 Git Workflow 与 Git Code Review Workflow GitLab Code Review 配置说明 GitLab Code Review 流程演示 GitLab For IDE 插件介绍(JetBrains等等) 2、GitLab Code Review机制 GitLab可以在...

ken的杂谈 848

提高 Code Review 质量的最佳实践

Code Review 是软件开发中至关重要的环节,它有助于确保代码质量、提高团队协作水平,同时也是一个学习和知识分享的机会。

nbsaas-boot基于Request-Response的企业级快速开发框架 699

idea中使用Code Review Helper

idea的代码工具CodeReview IDEA 插件:Code Review Helper,它的主要功能有:Alt+A快速添加注释行号旁边图标标识有检视意见的位置支持双击评审意见跳转到代码对应位置支持对评审意见的删除、修改支持评审意见内容导出为Excel表格支持将导出的Excel表格中的评审意见导入到IDEA中进行查看与管理。支持网络交互,适合团队协作场景使用支持评审字段的自行定制、或者团队统一定制从功能上看,切实解决了在gitlab中无法快捷方便的看全整体业务的问题。

cgk_ALEM的博客 1787

谈谈我们公司如何做Code Review

研发中心团队越来越庞大了,开发人员越来越多了。和他们聊天过程中,发现开发人员对代码技能的提升很迷茫,诉求越来越浓厚。只不过一个接一个的项目交付没有给他们太多停留的时间,在这种情况下如何给团队营造浓厚的工程师交流氛围呢?     方法有多种,最近进行了《代码分支管理》和《代码的好味道和坏味道之22种坏味道》培训,大家兴趣很高。但是最被认可的还是Code Review活动。     那么 Code...

bigdatafly 4482

Code Review时学到的技巧之isAssignableFrom

📆 最近更新:2023年4月1日🍊 个人简介:通信工程本硕 for NJU💪、Java程序员🌕。做过科研paper,发过专利,优秀的程序员不应该只是CRUD。

如切如磋,如琢如磨 3501

怎样在你的团队做 Code Review ?

怎样才是满怀仁爱地工作呢?那就是满怀热情地建造;满怀温情地播种耕耘;仿佛你所爱的人要来。那就是把你心灵的气息灌输到你所制作的一切之中去。雕刻大理石,在石头里寻找自己的灵魂。(纪伯伦)在现实中积聚新活力是一件伟大的事情。(Vincent van Gogh)引子KISS(keep it simple, stupid),意思是“保持简单和笨拙”(UNIX 哲学); Do one......

AI天才研究院 1万+

一、《Code Review中的几个提示》

Code Review应该是软件工程最最有价值的一个活动,之前,本站发表过《简单实用的Code Review工具》,那些工具主要是用来帮助更有效地进行这个活动,这里的这篇文章,我们主要想和大家分享一下Code Review代码审查的一些心得。 首先,我们先来看看Code Reivew的用处: Code reviews 中,可以通过大家的建议增进代码的质量。 Code reviews 是一个传递知识的手段,可以让其它并不熟悉代码的人知道作者的意图和想法,从而可以在以后轻松维护代码。 Code rev.

wuyilin513的专栏 1754

ADS2023仿真变容二极管特性

仿真S-Param仿真控件,设置为Single Point,将频率设置为1MHz,同时勾选Z-parameters,取消S-parameters,从元件库中选择元器件搭建原理图,并根据器件spice提供的相关参数,对原理图中器件参数进行修改,修改完成的电路图如下图所示。添加var控件和MeasEqn控件,相关设置如图所示,Ct为变容管的电容值,Q0为其品质因数。因此,对变容二极管的模型仿真结果是可以信赖的。将其解压,在spice文件夹中,可以找到我们想要的器件参数,和仿真简要电路图。

weixin_45811090的博客 1万+
上一篇: 分库分表就能无限扩容吗,解释得太好了!
下一篇: 不服输,你就不会输!(一份热腾腾的面经)
公众号-芋道源码
博客等级 码龄10年 1639粉丝 377原创
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付:10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值