刚进美团,就被各种Code Review,真的有必要吗?
点击关注公众号,Java干货及时送达
众所周知,Code Review是开发过程中一个非常重要的环节,但是很多公司或者团队是没有这一环节的,今天笔者结合自己所在团队,浅谈Code Review的价值及如何实施。
1. CR的价值
许多团队没有Code Review环节,或者因为追求项目快速上线,认为CR浪费时间;或者团队成员缺少CR观念,认为CR的价值并不大。所以想要推动CR在团队中的实施,最最重要的一点便是增强团队成员对CR环节的认同感。
Code Review环节,它更加依赖于团队成员的主观能动性,只有团队成员对其认可,他们才会积极地参入这一环节,CR的价值才能最大化的体现。如果团队成员不认可CR,即使强制设置了CR流程,也是形同虚设,反而可能阻碍正常开发流程的效率。那么如何让团队成员认可CR环节呢,自然是让他们意识到CR的价值,然后就会……真香!
1.1 提升团队代码质量
随着团队规模的扩大和项目的迭代升级,团队之间的信息透明度会越来越低,项目的可维护性也会越来越差,可能引发如下一系列问题:已有的utils方法,重复造轮子
代码过于复杂,缺少必要注释,后人难以维护
目录结构五花八门,杂乱不堪
……
合理的CR环节,可以有效地把控每次提交的代码质量,不至于让项目的可维护性随着版本迭代和时间推移变得太差,这也是CR的首要目的。CR环节并不会降低开发效率,就一次代码提交来说,也许部分人认为CR可能花费了时间,但是有效的CR给后人扩展和维护时所节省的时间是远超于此的。
1.2 团队技术交流
Reviewer和Reviewee,在参与CR的过程中,都是可以收获到许多知识,进行技术交流的。有利于帮助新人快速成长,团队有新人加入时(如实习生和校招生),往往需要以为导师带领一段时间,通过CR环节,可以使导师最直接的了解到新人开发过程中所遇到的问题,作出相应的指导。通过CR环节,团队成员可以了解他人的业务,而不局限于自己的所负责的业务范围。项目发现问题时,可以迅速定位到相关业务的负责人进行修改。同时若有的团队成员离职后,也可以减少业务一人负责所带来的后期维护困难。学习他人的优秀代码。通过CR环节,可以迅速接触到团队成员在项目中解决某些问题的优秀代码,或者使用的一些你所未接触过的一些api等。
1.3 保证项目的统一规范
既然要进行CR,首先要对项目的规范制定要求,包括编码风格规范、目录结构规范、业务规范等等。一方面,统一的项目规范才能保证项目的代码质量,提高项目的质量和可维护性;另一方面,在大家熟悉了统一的规范后,能够提升CR的效率,节省时间。
2. Code Review的实践
关于Code Review的实践,要考虑的包括CR所花费的时间、CR的形式、何时进行CR等等。
2.1 预留CR的时间
首先不得不承认,CR环节是要耗费一定时间的,所以在项目排期中,不仅要考虑开发、联调、提测、改bug等时间,还要预留出CR的时间。包括担任Reviewer和Reviewee角色的时间都要考虑。
另外如果遇到的需求比较复杂,为了避免因为CR过程导致代码需要大量修改,最好提前和团队成员沟通好需求的设计和结果思路。
2.2 CR的形式
我所见过的CR大多有两种形式。一种是设立一个特定时间,例如每周或者每半月等等,团队成员一起对之前的Merge Request进行CR;另一种是对每次的Merge Request都进行CR。
我个人更偏向于后者。第一种定期CR,Merge Request的数量太多,不太可能对所有的MR进行CR,如果CR之后再对之前的诸多MR进行修改成本太大;而且一次性太多的CR会打击团队成员的积极性。第二种MR相对就轻松的多,可以考虑轮班每天设置2-3人对当天的MR进行CR即可。
2.3 CR的时机
CR的环节应该设立在提测环节之前。因为CR后如果优化代码虽然理论上只是代码优化,但很可能会对业务逻辑产生影响,如果在提测时候,那么可能会影响到已经测试过的功能点。
当然也要分情况,如果遇到比较紧急的需求或者bug修复,那么也可以先提测,后续再做相应的CR。
3. 对团队成员要求
前面已经提到,要增强团队成员对CR环节的认同感。作为CR环节的参与者,还应该根据自己的团队特点,对团队成员做出相应要求,可以参考我们团队。
3.1 Reviewer
指明review的级别。reviewer再给相应的代码添加评论时,建议指明评论的级别,可以在评论前用[]作出标识,例如:
[request]xxxxxxx 此条评论的代码必须修改才能予以通过
[advise]xxxxxxxx 此条评论的代码建议修改,但不修改也可以通过
[question]xxxxxx 此条评论的代码有疑问,需reviewee进一步解释
讲明该评论的原因。在对代码做出评论时,应当解释清楚原因,如果自己有现成的更好地解决思路,应该把相应的解决思路也评论上,节省reviewee的修改时间。
平等友善的评论。评论者在review的过程中,目的是提升项目代码质量,而不是抨击别人,质疑别人的能力,应该保持平等友善的语气。
享受Code Review。只有积极的参与CR,把CR作为一种享受,才能将CR的价值最大化的体现。
3.2 Reviewee
注重注释。对于复杂代码写明相应注释,在进行commit时也应简明的写清楚背景,帮助reviewer理解,提高review的效率。
保持乐观的心态接受别人的review。团队成员的review不是对你的批判,而是帮助你的提升,所以要尊重别人的review,如果review你感觉不正确,可以在下面提出疑问,进一步解释。
完成相应review的修改应当在下面及时进行回复,保持信息同步。
来源 | https://urlify.cn/eIzyya
热门内容:史上最强Redis6.0,世界排名第一!为什么不推荐使用BeanUtils属性转换工具
Redis分布式锁使用不当,酿成一个重大事故,超卖了100瓶飞天茅台!!!
常用正则表达式最强整理(速查手册)
最近面试BAT,整理一份面试资料《Java面试BAT通关手册》,覆盖了Java核心技术、JVM、Java并发、SSM、微服务、数据库、数据结构等等。获取方式:点“在看”,关注公众号并回复 666 领取,更多内容陆续奉上。
明天见(。・ω・。)ノ♡
刚进美团,就被各种Code Review,真的有必要吗?相关推荐
- 刚入职,就被各种 Code Review,真的有必要吗?
点击上方蓝色"方志朋",选择"设为星标" 回复"666"获取独家整理的学习资料! 来源:juejin.cn/post/ 6882333635 ...
- 从零开始 Code Review,两年实战经验分享!
点击上方"方志朋",选择"置顶公众号" 技术文章第一时间送达! 来源:http://t.cn/RtHE14S 前几天看了<Code Review 程序员的 ...
- 在腾讯,如何做 Code Review
作为公司代码委员会 golang 分会的理事,我 review 了很多代码,看了很多别人的 review 评论.发现不少同学 code review 与写出好代码的水平有待提高.在这里,想分享一下我的 ...
- Code Review的亲身实践
Code Review,中文叫代码审查,指的是完成了部分功能的代码开发之后,在代码真正合并到仓库主分支之前,邀请同事帮你进行代码的审核和检查,检查代码的质量.规范.设计等等方面的过程. 代码审查的好处 ...
- 腾讯如何做 Code Review的?万字详解!
点击"开发者技术前线",选择"星标????" 在看|星标|留言, 真爱 作者:cheaterlin,腾讯 PCG 后台开发工程师 来自:腾讯技术工程 前言 作 ...
- 我们是怎么做Code Review的
前几天看了<Code Review 程序员的寄望与哀伤>,想到我们团队开展Code Review也有2年了,结果还算比较满意,有些经验应该可以和大家一起分享.探讨. 我们为什么要推行Cod ...
- 万字详文告诉你如何做 Code Review
点击上方"小白学视觉",选择加"星标"或"置顶" 重磅干货,第一时间送达本文转自|机器学习实验室 前言 作为公司代码委员会 golang 分 ...
- 在腾讯,如何做 Code Review?
作者:cheaterlin,腾讯 PCG 后台开发工程师 前言 作为公司代码委员会 golang 分会的理事,我 review 了很多代码,看了很多别人的 review 评论.发现不少同学 code ...
- Code Review 是一场苦涩但有意思的修行
来自:阿里巴巴中间件 文 | 孤尽 前言 最近 CodeReview(以下简称CR )心态相当的平和,代码是一个讲道理的东西,是就是,否就否.在 CR 时,沟通特别轻松,问题讨论也特别聚焦,因为它 ...
最新文章
- 一群工程师,让听障群体“看见”了声音
- ie6 select出现在浮动层上面的解决方法
- easyui 渲染问题(转)
- linux php添加mysql扩展模块_linux下为php添加扩展库的方法
- tensorflow/pytorch 设置GPU的使用
- Sybase获取所有用户表,以及所有者(owner)
- 2021ACA世界大赛线上全球总决赛,绽放中国创意设计色彩
- 阿里云ESS弹性伸缩服务新功能来袭,更全面、更自动化的使用体验
- MAC - macbook Ctrl键失灵的解决办法
- python第二版课后答案第七章7.5_IDA7.5 启动基础配置
- 2022 年排名前 10 的聊天机器人[示例]
- BeautifulSoup及爬取豆瓣评论
- 使用GatewayWorker框架,多个workerman进程(businessworker)负载不均衡的问题解决过程
- 《编译原理-龙书》练习第2章
- uni-app如何使用vant-ui
- 对谈 | 创新与进化——当开源接受SaaS
- 火箭发射理论(基础篇-未完待续)//2021-1-27
- 组件扫描器及spring头部配置文件的讲解
- Java 8中的mapToInt
- android手机USB转hdmi,【魅族MX评测】micro USB转HDMI 魅族MX自带MHL功能详解-中关村在线...