本文转载自微信公众号《Java极客技术》,作者鸭血范。转载本文请联系Java极客技术公众号。大家好,我是阿凡。相信大家对codereview都会很熟悉,但是我觉得能在日常工作中使用并坚持执行的公司或者团队并不多,但是codereview的好处是有目共睹的。是的,很多招聘信息都有这样的要求。坚持代码审查对团队和公司都有好处,尤其是对写代码的同事!每一个一起看代码的同事都会提出一些建议。这些建议是宝贵的资源,通常会产生很好的效果。那么如何做好代码审查呢?要想做好codereview,首先我们要知道在codereview过程中都有哪些角色,需要什么样的流程。角色代码作者;看代码的同事Reviewer;版主主持;录音机录音机。Process提前一天给相关人员发reviewcode邮件,确定Host和Recorder;由东道主主持审查会议;由审阅者和作者进行代码阅读;通过记录器改进记录。在做codereview之前,Author需要提前一天给相关人员发一封官方邮件,将需要review的代码通过邮件附件发送给相关Reviewer,让他们提前阅读,这样有助于审查更有效率地进行。并提前沟通好codereviewmeetingHost和Recorder。主持人负责会议期间组织发言和维持秩序,让codereview更有效率;Recorder负责记录整个review过程中需要优化和改进的点。记录的信息需要简明扼要。文件中哪一行代码,有什么问题,如何优化应该写下来,会后以邮件的形式发给Author和CC大家。Review在进行代码审查时,Author需要从文件的第一行开始逐行阅读代码,并对每一行的代码进行描述。这里需要注意的是,不要认为某个功能很简单,一句话就可以提到。往往很多线上的bug都是由于这种疏忽造成的。作者在阅读代码的时候,需要把每一行代码的意思解释清楚,说明这行代码是干什么的,为什么要这样写。Reviewer需要根据Author的描述结合自己对之前阅读过的代码的理解提出问题或改进方案。在代码阅读过程继续进行的同时,Recorder需要及时记录需要改进的内容,并记录建议的优化方案。代码阅读的过程是整个Review的核心,这个环节需要我们注意很多地方。知乎上有人问你们公司的CodeReview是怎么做的?你遇到过什么问题?上面的回答中有几点提得非常好。我觉得有必要分享给大家。对于我们整个Review都会有很大的帮助,尤其是当你是Reviewer的时候,需要格外注意。不待人。请记住,每个人都是同事。今天我是Reviewer,去review别人的代码,总有一天别人会去review自己的代码,所以在整个codereview的过程中,我们可以提出自己的建议,但是需要注意自己的用词和语气。虽然程序员有鄙视链,认为别人的代码是垃圾,但是这个时候,不能乱说,容易打架,要谦虚点。使用积极的词语进行评价。如上所述,我们需要用积极的词汇来评价代码,考虑作者的情绪,即使代码写得不好。这很容易理解。毕竟codereview是摆在很多人面前的。对于Author来说,让别人看到你写的代码就像在别人面前裸奔一样,所以我们不仅要在好的地方提出意见,更要正确表扬。如果有更好的解决方案,一定要提出来。代码审查的目的是优化代码,发现代码中隐藏的错误和逻辑问题。所以如果你发现代码中有什么不优雅的地方或者会出现问题的地方,一定要及时提出来。不要担心自己说的不对,或者顾及作者的面子,也不要点出来。提供更好的解决方案,让我们共同进步。审查会议是为了审查代码,而不是讨论需求。这也是容易偏颇的一点。我们经常发现,在review过程中,它逐渐变成了一个discussionrequirement。必须避免这种情况,否则整个代码审查过程将失败。不能继续了。所以Author在发起codereview邀请的时候,一定要保证自己理解的需求是正确的,以免浪费大家的时间。高效进行。在进行代码审查时,我们需要注意效率。如何做到高效率,需要大家做好相应的准备。作者需要熟练地解释他们的代码。审稿人需要在参会前阅读需要审稿的代码。提前找出可能隐藏的bug,有不懂的地方做个记录,方便开会时及时指出。避免形式主义。这一点也被很多小伙伴忽略了。随着codereview的次数越来越多,很多小伙伴可能会把这当成一个任务,逐渐变得形式主义,而不是注重实际。codereview很随意。长期这样下去,对公司、对团队、对自己都不好,是浪费时间。小结今天阿芬给大家介绍一下如何做一个合格的codereview。当然,这只是阿芬自己的一些看法。大家有什么意见可以在评论区给我们留言,大家一起交流学习。
