【译】为什么要进行代码审查

原文: why review code
作者:Siphie Alpert

一个朋友最近问我为什么做代码审查是有价值的。 至少,大多数硅谷科技公司会对程序每一个变化进行审查,每个变化至少两双眼睛的关注。 我们曾做了一段时间的代码审查(但是很少) ,然后一个来自谷歌的新员工加入了之后,鼓励我们审查我们所有的代码——我们确实这样做了。现在看来这是一个伟大的决定。

如果你使用正确的审查代码的方式,那就不会觉得工作量很大。 你和你的审查者并不是对立的; 你们一起工作,一起产出最好的产品。 (重要的是,不要把反馈私下处理——即使你的代码需要更改,因为这并不意味着你有问题。 得到反馈是很正常的,这样才能帮助你成长)

一些公司对于每一段代码需要多少人来审查有非常复杂的规则,每一段代码都有严格的“负责人”。 我倒觉得并没有这个必要的; 我更喜欢一个简单的机制,唯一的规则是每一段代码都必须至少由一个人来审查。 而在实际操作上,你仍然会将反馈发送给维护你审查的这段代码的负责人,但是我认为不做硬性要求也很好。

我为什么认为代码审查是有巨大价值的?在这里罗列一些主要理由:

  1. 代码本身。代码评审最明显的价值通常被定义为“发现bug”。 如果你能看得更远,还能发现被开发者忽略的最佳实践,或者潜在规则的案例。在这些案例中,评审者可以向开发者反馈,以提高实际的具体代码水平。

  2. 宏观层面的知识分享。 当你检查别人的代码时,你会倾向于学习新的技术,这些技术以后会对你有益,反之亦然,会有人在检查你的代码时提出一个更好的方法。如果你能把你学到的东西用在以后的工作中,你就能成长为一名优秀的工程师。

  3. Micro-level knowledge sharing. Or, mitigating the “bus factor” by increasing the number of people who are familiar with any given piece of code.(这句并不是很理解)

  1. 技术方向分享。 代码审查迫使你与团队成员交流你正在做的事情,这能确保你不会持续几天或几周的时间走在错误的方向上,他们会马上给你反馈。
  1. 沟通练习。 无论是在团队内部还是团队之外,清晰无误的沟通能力,是在工作中取得成功的最重要的技能之一。 代码审查让你有机会练习表达能力,一是在描述变更的目的时候,还有在向队友提供反馈时。 运气好的话,下次你需要写一些“真正重要”的东西时候,你会准备得更充分。

  2. 历史记录。 根据我的经验,当人们知道有人在读信息时,他们往往会写得更好。 这在以后回顾过去的变化时非常有用。

  1. 利于讨论。 当你们试图作出一些程序上的改变,想要达成一致意见,有时候很难口头描述某个特定算法的细节。 那么通过一段代码进行信息的传递就可以更加精确,因为代码通常是毫不含糊的。

8)团队凝聚力。 当你进行常规的代码审查时,就会感觉是一个团队在一起工作,而不是每个人都在"各司其职"。

9)阅读练习。 练习阅读他人的代码可以提高你的认知:如何使你自己的代码更具可读性(从而更易于维护)。 这会对你的代码质量产生长远的积极影响。

如果让我选的话,2、5、6可能是最有价值的。

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

推荐阅读更多精彩内容