微软如何做好Code Review

从不同的视角来看有哪些最佳实践呢?

  1. 提交代码修改的人
阶段 最佳实践
准备需要review的修改 1.彻底地看过自己要提交的更改,确保是需要review的内容
2.每次更改都是小的递增的修改,且应当是紧密相关的,以便易于理解,不要一次提交大量代码变动
3.应当附带说明信息,说明每处修改的动机,描述改动了什么
4.在发起review前先测试改动,提交测试的相关信息
5.使用自动化代码分析工具,检查代码格式风格,处理一些低级的问题
6.一些很小的,不重要的改动,可以跳过review。比如一些不涉及程序逻辑变动的修改,比如注释、格式等
选择帮忙做review的人 1.决定需要多少个人帮忙review
2.选择合适的有经验的人来review,不一定要最有经验的人,应当权衡他们的时间
3.允许别人自愿参加review
4.通知那些参加review可以获益的人,比如新人,他们可以从中学习
对review做出响应 1.对帮忙review的人表示感激
2.使用有效的手段去沟通,邮件/即时通讯/电话/面对面沟通,取决于修改的复杂度
3.对review的结果进行跟踪,确保bug修复,建议得到跟进
  1. review 代码的人
阶段 最佳实践
处理一个review 1.为review预留足够的时间,确保理解修改了什么东西
2.经常性review,每次review 少量改动
3.尽快地进行反馈,以便大家还对这个改动有记忆
4.关注核心的问题,不要一直纠结在一些小问题上面
5.用一个checklist列出你关注的问题,甚至可以为这个项目定义一些特定的关注事项
提供反馈意见 1. 选择合适的沟通手段,取决于你要说的问题多复杂
2. 一些没有很大争议,不太敏感的内容,可以直接利用review工具提供的评论功能进行反馈,以便于追踪讨论历史
3.给出有建设性的意见,同时也要尊重他人
4.解释清楚你拒绝本次变动的原因
  1. 组织的角度
最佳实践
1.建立一种积极的review 文化,让大家直到review是是一种互惠的活动
2.在项目里,确保review的时间也被预计在内,因为他也是软件生命周期重要的部分
3.关注review中消极的部分,认真做review应当称赞,也有人把review当做走流程,视为儿戏
4.确保有效的自动化工具,使得review 顺利进行
5.不断回顾和迭代review策略,关注它对开发效率,产品质量,开发者的满意度的影响
6.关注review中一些不合适的言辞、争论的
7.要有合适的培训,确保大家的review高效

参考:《MS-Code-Review-Tech-Report-MSR-TR-2016-27》

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