有效代码评审的十条军规

有家叫作 SmartBear 公司, 我用过他们的一款代码审查的工具 Code Collaborator , 对于代码审查,觉得他们总结的十条最佳实践挺不错, 顺手翻译如下, 未严格遵循原文翻译, 并加了点评注, 原文参见 https://smartbear.com/learn/code-review/best-practices-for-peer-code-review

1.一次只审查小于 500 行的代码

2.不要着急, 代码评审的速率最好小于每小时500行

3.一次审查不要超过一个小时

4. 设立目标并检查相应的测试及度量数据

如何你的实现某个功能的, 跑几个相应的集成测试
如果你是优化某个性能的, 给出一个性能优化数据
如果你是应对某种异常的, 给出相应的异常测试用例

在代码审查结束后, 也给出一个总结:

  • 花费了多长时间(Man Hour),
  • 每小时审查了多少行代码,
  • 找出了多少bug (平均每百行bug率是多少)
  • 代码的相关测试是否充分和有效率
  • 发现了多少设计上的问题
  • 发现了多少可靠性与异常保护方面的问题
  • 发现了多少有关可理解性和可维护性的潜在问题

5.作者应该在代码审查之前对代码给出相应的说明和注解

6. 使用静态代码检查工具和检查表

先自查, 再互查

7. 建立一个跟踪修复所发现问题的流程

比如

  • 创建一个git issue 或报一个bug来跟踪问题,指定专人对修复 bug 的代码作再次审查
  • 对设计或需求上的问题作出后续的安排,如需求或设计评审会议
  • 对疑难问题创建一个任务进行后续研究
  • 等等

8.培育一个积极的代码评审文化

代码评审可能会遭遇抵触情绪, 造成同事之间关系紧张, 应该树立这样一种观念, 越早发现问题越好,代码评审是最有效率的提高代码质量, 提升代码水平的手段, 互相协作和学习才可以共同进步。
在代码评审时, 要对事不对人, 保持谦逊和礼貌, 代码评审的结果不可作为业绩考核的数据标准

9. 重视代码评审的潜在作用

有人会检查你的代码, 自然会驱动你写好代码。为了面子, 你也会有更多动力写出更优雅的代码

10. 实践轻量级的代码评审

无需每次开会来审查代码, IM, Pull Request, 面对面的一起结对审查代码都是不错的方法

另外,说点代码评审的个人感受

1. 适可而止

几乎没有十全十美无可挑剔的代码,总是有些许改进的空间,不必过度优化,过度设计,把握住基本原则,适可而止,关键要看是否变得更好,以后是否留下隐患或者更大的麻烦

2. 和谐共赢

人性的弱点在于喜欢表扬,反感批评,代码评审要对事不对人,讲究方式方法,顾及到别人的感受,先肯定,再否定,给别人台阶下,谁敢说自已的代码没毛病,少说感觉,多讲原则,不提个人喜好,只讲利弊分析

3. 有始有终

代码评审会议一定要有记录,有跟踪,有始有终,每一条反馈意见都要落实,代码一定要有类似于pull request 的比较评注工具,发现的常见问题最好整理总结出来,作为参考比如Checklist, FAQ 或者 best practice

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

推荐阅读更多精彩内容

  • 文章来自:http://blog.csdn.net/mj813/article/details/52451355 ...
    好大一只鹏阅读 9,186评论 2 126
  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 171,400评论 25 707
  • 1.测试与软件模型 软件开发生命周期模型指的是软件开发全过程、活动和任务的结构性框架。软件项目的开发包括:需求、设...
    宇文臭臭阅读 6,704评论 5 100
  • 睡不着看到朋友圈这张图就发到自己朋友圈里 你发过来“你觉得我们的友谊会长久么”我不假思索的回“会”但转念一想觉得自...
    Clytze大唯阅读 777评论 1 1
  • 欧律诺墨 开天辟地的混沌之神 沃黑的大地 北风在欧律诺墨的揉搓中变成了大蛇俄菲翁,它们俩纠缠在一起,结合了,有孕的...
    入岫云心阅读 3,469评论 0 0