查看CL(提交列表)

既然您已经知道Code Review应该Review什么,那么管理跨多个文件的评审的最有效方法是什么呢?

  • 这种变更合理吗?它有一个好的描述吗?
  • 首先查看最主要部分的变更。它的整体设计好吗?
  • 按照适当的顺序查看CL的其余部分。

第一步:从更广阔的角度看待变更

查看CL的描述和CL的一般功能。这种变更合理吗?如果这个变更一开始就不应该发生,请立即解释为什么不应该变更。当您拒绝这样的变更时,向开发人员建议他们应该做什么也是一个好主意。

例如,你可以说“看起来你在这方面做得不错,谢谢!但是,我们实际上是要删除您在这里修改的FooWidget所在的系统,所以我们现在不想对它进行任何新的修改。不如重构我们的新BarWidget类?”

请注意,评审人不仅拒绝了当前的CL并提供了一个替代的建议,而且还很有礼貌。这种礼貌是很重要的,因为我们想要表现出我们作为开发者彼此尊重,即使我们意见不一致。

如果您得到了多个您不希望进行变更的CLs,那么您应该考虑为外部贡献者或您的团队重新制定开发流程或发布的流程,以便在编写CLs之前进行更多的沟通。在人们做了大量的工作,最好在不得不扔掉或彻底重写之前,对他们说“不”。

第二步:检查CL的主要部分

找到一个或多个文件是这个CL的“主要”部分。通常,有一个文件的逻辑更改数量最多,它是CL的主要部分。首先看看这些主要部分。这有助于为CL的所有更小的部分提供上下文,并且通常会加速代码检查。如果CL太大,您无法确定哪些部分是主要部分,请询问开发人员应该首先查看哪些部分,或者请他们将CL分成多个CL

如果您看到CL的这一部分存在一些主要的设计问题,您应该立即发送这些评论,即使您现在没有时间来查看CL的其余部分。

实际上,检查CL的其余部分可能是浪费时间,因为如果设计问题足够严重,那么很多其他正在检查的代码将会被删除,不管怎样都无关紧要。

有两个非常重要原因需要我们立即评论这些关于主要的设计的问题:

  • 开发人员通常会发送一个CL,然后在等待评审期间立即根据这个CL开始新的工作。如果您正在审查的CL中存在主要的设计问题,那么他们也将不得不重新处理后面的CL。你想在他们在有问题的设计上做太多额外的工作之前避免这种情况的发生。
  • 主要的设计变更比小的变更需要更长的时间。开发人员几乎都有最后期限;为了在最后期限前完成这些工作,并且在代码库中仍然有高质量的代码,开发人员需要尽快开始对有设计问题的CL进行重写。

第三步:按照适当的顺序查看CL的其余部分

一旦您确认了CL整体上没有重大的设计问题,那么请尝试找出一个逻辑顺序来检查这些文件,同时确保您不会错过检查任何文件。通常,在您浏览完主要文件之后,最简单的方法就是按照代码审查工具显示文件的顺序浏览每个文件。有时,在阅读主代码之前先阅读测试也是有帮助的,因为这样您就会对变更应该做什么有一个概念。

下一章: Review的速度

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,271评论 5 476
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,275评论 2 380
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,151评论 0 336
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,550评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,553评论 5 365
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,559评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,924评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,580评论 0 257
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,826评论 1 297
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,578评论 2 320
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,661评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,363评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,940评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,926评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,156评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,872评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,391评论 2 342

推荐阅读更多精彩内容

  • 注意:在考虑这些要点时,一定要考虑到Code Review标准 设计 在评审中最重要的是CL的整体设计。CL中不同...
    老猫_jerry阅读 624评论 0 1
  • 去年有段时间得空,就把谷歌GAE的API权威指南看了一遍,收获颇丰,特别是在自己几乎独立开发了公司的云数据中心之后...
    骑单车的勋爵阅读 20,427评论 0 41
  • feisky云计算、虚拟化与Linux技术笔记posts - 1014, comments - 298, trac...
    不排版阅读 3,813评论 0 5
  • 从有了微信开始,就停用QQ了,大概四年多了吧。最近偶然登录QQ,翻看以往的说说,很是感慨。 QQ里的说说非常随性,...
    知识管理某李阅读 349评论 0 0
  • 1.我傲娇地认为,言语是魔法世界永不枯竭的资源。他既能造成伤害,也能修复他。 2.也许他正发生在你的脑中,但究竟为...
    简字旁阅读 520评论 0 2