【译】如何利用代码审查提升你的代码质量?

代码审查会减缓自己代码的进度,但也是一个提升自己代码,并向其他聪明、经验丰富的工程师学习的机会。那么怎么才能充分利用这个机会呢?

尽量让你的代码变动出现在第一轮审查中,只有轻微的评论。如果你的代码审查通常需要多轮的意见,这些技巧可以节省你的时间。

有效的利用你的代码审查者的时间,这是一种有限的资源。如果他们发现了那种你自己很容易就能发现的问题,这会降低你的团队的整体工作效率。

在你的代码进行审查之前:

重新评估你的代码:不要像以前测试时一样随便把评审代码送去审查。至少要重新从整体上思考一遍。尤其是如果当天时间已经晚了,看看第二天早上是否会有更好的想法。虽然这样可能会拖慢个人代码的变化,这将从长期上带来更大的平均吞吐量。

考虑做一次非正式的设计探讨:如果你有不确定的事,和审查者面对面交流,或提前提出异议并要求一次整体设计上的“预审”。

自行审查更改:试着从一个什么都不知道的人的角度,尽可能严格的看自己的代码。你的代码审查工具会比IDE更能给你根本上的不同看法。这将很容易的为你免去一次往返。

使差异容易理解:一下子出现的多种改变让代码更难审查。当你自行审查,寻找能减少差异的简单更改。例如,保证重要的重构或格式变化。

不要隐藏提交消息中的重要信息:把它也放在代码中。之后阅读代码的人是不可能看提交的消息的。

当你处理代码审查意见:

处理完重要意见后,重新评估你的代码:退一步并用真正全新的眼光去看代码。一旦完成了一组更改,你会发现,这些更改经常会带来额外的改进。正如任何的重构,它可能需要几个步骤来达到最佳设计。

弄明白审查者做出的每一个注释:如果你不明白注释背后的原因,不要仅是修改代码——去找审查者弄清楚,以便自己能学习新的东西。

回复审查者在代码上的问题:不只是回复——让代码更容易理解(例如,提高一个变量名、更改一个布尔值等等)——或添加注释。以免之后其他人也会有同样的问题。

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

推荐阅读更多精彩内容