[CC说]你的代码评审需要来一次清单革命!

“为什么本该在90分钟内完成的心脏急救检查,成功率不到50%?为什么会有高达2/3的死刑判决发生了错判?我们到底能掌控多少?又有哪些事根本不在我们的可控范围内?
或许,我们犯错,是因为没有掌握相关的知识;或许,我们犯错,不是因为没有掌握相关的知识,而是没有正确使用这些知识。人类的错误分为两大类型,“无知之错”,可以原谅;“无能之错”,不被原谅。”
- 《清单革命》

通常在项目中,代码评审是不可或缺的一个环节,很多时候代码质量在某种程度上也就是被这种机制所守护。

多数的团队困惑不在于做不做代码评审,而是我们需要什么样的大神来做代码评审呢?


ExpertCodeReviewer.png

就像感慨每一个公司都希望有一个乔布斯来设计产品一样,每一个团队都希望有一个Guido van Rossum(Python之父)或者James Gosling(Java之父)来帮忙评审代码。

只是,我们真的是如此的无知么?

在这个知识付费遍地跑,Google资料一大把的年代,知识对我们来说不是太少,而是太多。

本着精简主义原则,先让我们来聊聊 代码评审中不该做的事儿。

What Not To Do

设计
代码评审是审查现有代码并从中学习的过程, 而不是讨论设计思想的时间或地点。如果想到设计思路,请将它们分开写下来,并在代码审查之外进行讨论。

编写代码
如果您正在编写任何代码,则不会进行评审。唯一的例外是注释中的两行代码短行,以帮助传达缺陷或建议的修复。

批判
代码评审是团队中的每个人在改进代码的同时学习和编写更好的代码的机会。我们都犯错误,我们都有机会学习。代码中的缺陷是每个人学习和改进的机会。

To Do

代码评审检查清单
1935年的时候,波音公司研制的B-17型轰炸机,在进行试飞过程中发生了爆炸。针对这个巨大的缺陷,波音公司不是大幅度改进了这个型号飞机的机械系统,而是将飞机的起飞、巡航、着陆、滑行等各个阶段的重要步骤浓缩到一张卡片上,飞行员会根据清单的提示检查刹车是否松开、分析仪表是否准确设定、机舱门窗是否完全关闭,还有升降舵能控制版面是否已经解锁?

在飞行手册上,正常的检查清单不过3页,剩下的200多页都是针对异常情况的检查项。当异常发生时,飞行员能够依据清单来化解危机。


使用清单的男生特别帅.jpg

你的清单中可以包含,但不仅限于以下的内容:

  • 可维护性

    1. 代码有意义吗?
    • 在执行代码审查之前,请努力了解代码应该执行的操作。
    • 要求开发人员尽可能多地发表评论以使代码可读。
    1. 代码是否符合公认的Java约定
    2. 代码是否符合公认的最佳实践?
    3. 代码是否符合公认的评论约定?
  • 错误处理
    1.代码是否符合公认的异常处理约定。
    2.代码是否只是捕获异常并记录它们?

  • 安全

  • 资源泄漏

  • 控制结构

  • 可重用性

  • etc

可以的话,你也能拥有那么长长的checklist,只是要记得依据你们团队的情况去定期更新它。

如何持续、正确、安全地把事情做好,这正是清单工具的魅力所在。

所以,你准备好你们组的代码评审的清单革命了么?

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

推荐阅读更多精彩内容

  • 1990 年8 月8 日发布1991 年4 月9 日第一次修订1998 年8 月20 日第二次修订2007 年4 ...
    littlelan阅读 6,703评论 0 4
  • 前几日失眠的时候,忽然想到自己以前追的名字叫《极平家丁》的电视剧,于是便点开看了看。可没看一分钟,便觉得无趣,看起...
    爱读书的无为阅读 4,965评论 1 2
  • 2018.4.3 《江上渔者》 江上往来人,但爱鲈鱼美。 君看一叶舟,出没风波里。 【诗人简介】 范仲淹,字希文,...
    Ice的零度空间阅读 693评论 0 0
  • 不知不觉已经来到这个地方一年半,是该说时间真快?还是说人生太慢? 我不喜欢繁华时的美好,更喜欢败落时的美丽。是该说...
    爱吃面包的树阅读 279评论 0 3
  • 最近脑海里总回想起童年时候走过的田埂小路,那是一条从我家到外公家的田埂路,以小孩子的脚程也不过15分钟,但是对于...
    Rabbit_9621阅读 437评论 0 0