本文转载自微信公众号「Java极客技术」,作者鸭血粉丝。转载本文请联系Java极客技术公众号。
Hello 大家好我是阿粉,代码 Review 相信大家一定不会陌生,但是真正在日常工作中能使用并且坚持执行下去的公司或者团队,阿粉觉得并不多,但是代码 Review 的好处大家都是有目共睹的,很多招聘岗位上面都有这样的要求,坚持执行代码 Review 对团队,对公司是很有好处的,特别是对写代码的同事!每个一起阅读代码的同事都会提出一些自己的建议 ,这些建议都是很宝贵的资源,往往都会有很大的收获。
那么如何做好一场代码 Review 呢?想要做好一场合格的代码 Review,首先我们需要知道代码 Review 的过程中都有哪些角色以及需要怎样的流程。
角色
流程
在做代码 Review 之前 Author 需要提前一天需要发正式邮件给相关人员,并且将需要被 Review 的代码通过邮件附件的方式,发送给相关的 Reviewer 让他们提前阅读,这样有助于 Review 的时候可以更高效的进行。并且提前沟通好代码 Review 的会议 Host 和 Recorder。Host 在会议过程中负责组织大家发言和维护秩序,让代码 Review 更高效;Recorder 则负责将整个 Review 过程中提到的需要优化和改进的点进行文档形式的记录,记录的信息需要言简意赅,将哪个文件哪一行代码,问题是什么,建议怎么优化都需要记下来,并且在会议结束过后以邮件的形式发送给 Author 和抄送大家。
Review
在进行代码 Review 的时候 Author 需要从文件的第一行开始进行一行行的代码走读,对每一行的代码进行描述,这里需要注意的是不要认为某个功能很简单,就可以一句带过,往往很多线上 Bug 都是因为这种忽略导致的。走读代码的时候 Author 需要解释清楚每一行代码的含义,说明这行代码是干嘛的,为什么要这样写。Reviewer 则需要根据 Author 的描述再结合自己之前阅读代码的理解进行提问或者改进方案。
代码走读的过程持续进行的同时 Recorder 需要及时记录需要改进的内容,并把提出的优化方案记录下来。代码走读的过程是整个 Review 的核心,在这个环节中我们需要注意很多东西。知乎上面有个提问大家的公司的 Code Review 都是怎么做的?遇到过哪些问题?,上面有个回答提出的几个点很不错,我觉得有必要分享给大家,对我们的整个 Review 会很有帮助,特别是当自己是 Reviewer 的时候,需要格外注意。
总结阿粉今天给大家介绍了一个如何做一个合格的代码 Review,当然这只是阿粉自己的一些见解,大家有任何意见可以在评论区给我们留言,大家一起交流学习。
客户简介 找靓机(深圳市万事富科技有限公司旗下app)是一个原装二手数码3C的直...
简介 在做科学计算的时候 我们需要从外部加载数据 今天给大家介绍一下NumPy中非...
操作场景 对于包年/包月购买的专属主机,如果您不再使用该资源,可以执行退订将...
租用大带宽的好处?大带宽租用价格。随着互联网时代的飞速发展,用户对网络的体...
驯化被认为是人类征服世界和改造世界最为重要的能力之一。我们爱吃大米,于是驯...
本文转载自微信公众号「前端思维框架」,作者ViktorHub。转载本文请联系前端思维...
近日,华为安全应急响应中心联合华为重明实验室举行鲲鹏技术平台漏洞奖励计划授...
一、什么是消息队列 消息队列 Message Queue 简称MQ 指保存消息的一个容器 本质...
2020鼠年情人节将要来临,请查收您的专鼠表白神器,“女神.我爱你” 域名 。马上...
为防控疫情,河北省当地决定从1月13日起在黄庄抢建一批集中隔离场所。1月22日,...