为什么要做代码审查

今天你 CR(code review)了吗?

CR ?哈哈,并没有。

老实说,就是自己写的代码,过了一段时间后,再去查看,也会很惊讶的说:这是我写的吗,也太不规范了吧。这首先说明了我在进步,其次,之前写的代码是有问题的。那就引出了一个问题,之前怎么没有发现呢?

对于自己写的代码,会潜在地产生一种信任和依赖,所以自己有时候是很难发现其中的明显的错误以及规范问题的。然而,对于其他人来说,一开始是不会进入这种 “自我信任” 状态的,所以较容易发现问题。CR就创造了这个机会,以第二双眼睛再次检查代码,帮助我们及时地发现潜在的问题。

有没有遇到过以下情况:因为一个非空判断而查找了好久;因为变量命名不规范而吐槽;因为关键参数没有添加说明,然后询问团队成员,但却被告知,相关人员已经离职了......诸如此类,其实大部分在CR的时候就能够发现并规避了。如果之前这样做了,现在根本就不用花费这么大的成本去还这些代码债务了。

CR分为正式代码评审和轻量级代码评审。后者更加便捷,也是经常被采用的。我们需要根据自身所处的环境进行选择,适当调整实践的方式。CR的主要目的是为了提高代码质量以及团队内部知识共享,提升团队的整体水平,并不是借此机会以缺陷和错误来批判他人。一直相信这一点,CR是不需要花大量的时间来执行的,但效果却是很显著的。

意识到CR的重要性后,怎样正确有效的实践CR也是很重要的。

Code Review的最大的功用是纯社会性的。如果你在编程的时候,知道将会有同事检查自己的代码,那编程的态度就完全不一样了,写出的代码将会更加整洁,有更好的注释,更好的程序结构。若没有代码审查,尽管还是会有人看到你的代码,但这种事情不是立即发生的事,谁知道是哪个时间点(so,you don't care),并且它不会给你带来同等的紧迫感和重视。

实践CR之前,团队成员间需要达成一个共识,制定一份合理的代码规范标准。以此为前提,后续再补充。代码规范与代码优化一定要区分开,不可相提并论。作为一个审查者,你的任务不是确保被审查的代码都采用你的编码风格,因为它不可能跟你写的一模一样,而是要确保被审查的代码的正确性。

其次,这是一个长期实践,不能中断,并且每次所用时间不宜过长。这是一个循序渐进的过程,不可能一次性到位。我们需要跨出最难的第一步,然后逐步解决遇到的 ”拦路虎“,不能因为各种各样的理由,就此中断。

实践CR的目的是服务于我们,不是以此为机会去打压他人。对于他人的代码,不是一定要做出评论,表扬或是批评,以突显自己的存在感。并且,这不仅仅是个人的事情,更应该是团队层级的,最主要的目的是为了提升团队的整体水平,保证代码的高质量。

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

推荐阅读更多精彩内容

  • 阅读Tips: 本文是我根据这么多年来的实际开发、技术管理经验的一些总结,完整阅读需要30分钟,已经整理成简书专题...
    hirainchen阅读 8,348评论 12 118
  • 前言 因为公司项目要实现一个效果,在ScrollView没有向下滚动时,下拉(未重写前下拉是没有任何效果的)放大顶...
    Raye阅读 2,836评论 7 35
  • 人生来孤独,来到世上应该是有一定使命的,陪到自己最后的还不知道是谁,在那之前找到了方向就走下去,就做自己该做的事,...
    一个时间里的人阅读 138评论 0 0
  • 22日,农业部对中国农业科学院北京畜牧兽医研究所肄业博士研究生魏景亮,实名举报国家转基因检测中心造假“大规?!献?..
    力量时评阅读 414评论 0 0
  • 《旗袍》 曲线婀娜美似花, 风姿曼妙雅如茶。 寻常服饰追时尚, 唯有旗袍最中华。 白云山人20160803
    赛德传播阅读 196评论 0 0