做不好 Code Review 的 6 大原因

发表于 4年以前  | 总阅读数:466 次

Code reviews 如果实施不当,它可能会严重拖慢团队的交付能力——许多代码更改会在 Code reviews 活动中停留几天(甚至几周),最终影响产品的上市时间。为何你的 Code reviews 可能会耗时长久,常见原因如下:

  • 缺乏编程指南
  • 没有使用自动化检查
  • 没有做自我审查
  • 提交了庞大的 PR
  • 提交了内容模糊的 PR
  • 没有为完成评审设定时间期限

缺乏编程指南

每个团队都应该有一套人人同意的编程指南。这套编程指南应该包含命名规范、文件夹结构、代码格式以及单元测试、验证等活动的最佳实践。

如果没有明确的指导方针和约定规范,每个开发人员就会按照自己喜欢的方式去编写代码,这将导致在 code review 期间出现大量争论和分歧。如果你注意到有许多关于代码格式、命名规范等方面的评论意见,那么你就需要开始组织团队开展关于编程指南的讨论了。

你的团队既可以制定自己的指南,也能借鉴其他公司的智慧,比如参考谷歌的编程风格指南。

没有使用自动化检查

一旦你有了文档化的编程指南,就能进一步探索使用工具去自动检查代码是否遵守指南规范。众所周知,几乎所有的编程语言都有 formatters、linters 等,你可以将这些工具与代码预提交或者 CI/CD 等活动关联起来。

这些工具会对代码进行遍历,检查其是否违反编程规范,并通知代码作者。在提交 PR 前,作者需要解决这些规范和格式问题,这样就能很大程度降低代码评审中所出现的干扰。交给自动化完成的工作越多,作为评审人的团队成员就有更多时间去关注代码中的大问题,这些问题包括设计缺陷、实现缺失等等。

不做自我审查

在要求其别人对自己的代码进行评审前,代码作者首先要自己检查一遍所做的更改。这就是所谓的“自我审查”,类似于我们在给别人发送电子邮件前先校勘一遍。

在实践中,审查自己的代码是一件很有挑战性的事情,因为会出现心理盲点(对自己代码中的缺陷,你可能心理上容易无意识地忽略掉。)以下这些方法,可以帮你更好的进行自我审查:

  • 在不指定任何代码评审员的情况下提交 PR,过几个小时后,自己再回来看看这部分代码,这样你会以全新的目光重新审视自己的代码更改。
  • 不要以一目十行的方式随意地快速浏览自己做出的代码更改,而是要刻意谨慎地去逐行仔细检查这些更改。
  • 按照一个检查清单去进行自我审查——比如,“代码是否遵循了编程指南?”,“我的代码是否已经涵盖了这些变更所需要支持的所有业务需求?”,“我是否为所有可能的用例编写了测试?” 等等。

提交了庞大的 PR

一个 PR 的评论数与 PR 包含的代码更改内容多少成反比。换句话说,越大的 PR 通常会获得越少的评论,而越小的 PR 则会获得越多的评论。

这是因为代码评审者在面对大 PR 所包含的过多内容,往往不堪重负,于是他们可能会快速浏览所有更改,从而快速结束此次 code reviews。这种做法实际违背了 code reviews 的根本目的。而且,有时还会发生相反的情况,一个 PR 里内容过多,吓得代码评审者迟迟不敢行动。于是乎,很多天过去了,这个 PR 都没动静,并未获得任何评论意见。

将一个大 PR 分解成更小的代码块,让这些内容彼此分隔,这个做法是有意义的。这会让代码评审者的活动变得更正确且更快速。

提交了内容模糊的 PR

一个代码评审者常常被要求去审查内容模糊或没有清晰功能描述的 PR。然后,代码审查者不得不通过试图回忆来自于每日站会或问题跟踪器上的任务,才能理解这些 d 代码更改意味着什么。

所以,建议为提交的 PR 添加更多细节信息,比如:

  • 这个 PR 包含了哪些更改?
  • 代码评审者应该从哪些文件开始审查?
  • 与之相关的问题跟踪器任务的链接
  • 如果带来产品视觉上的变化,请附上屏幕截图

添加这些信息,将会为代码评审者提供更多的上下文,从而有助于他们更快速审查你的 PR。

没有为完成评审设定时间期限

让提交的 PR 永远无法被合并的一种做法是,不为代码评审者完成评审工作设定任何时间期限。

请设定一个合理的时间期限,例如:

  • 代码评审应在提交 PR 后 48 小时内完成
  • 一个针对特定问题热补丁的代码评审必须在 30 分钟内完成

作者介绍Sheshbabu Chinnakonda,软件开发人员,问题解决者,喜欢构建新东西也喜欢修补东西。

参考阅读:

http://www.sheshbabu.com/posts/how-to-prevent-code-reviews-from-slowing-down-your-team/

作者丨heshbabu Chinnakonda 译者丨杨志昂 策划丨万佳

 相关推荐

刘强东夫妇:“移民美国”传言被驳斥

京东创始人刘强东和其妻子章泽天最近成为了互联网舆论关注的焦点。有关他们“移民美国”和在美国购买豪宅的传言在互联网上广泛传播。然而,京东官方通过微博发言人发布的消息澄清了这些传言,称这些言论纯属虚假信息和蓄意捏造。

发布于:1年以前  |  808次阅读  |  详细内容 »

博主曝三大运营商,将集体采购百万台华为Mate60系列

日前,据博主“@超能数码君老周”爆料,国内三大运营商中国移动、中国电信和中国联通预计将集体采购百万台规模的华为Mate60系列手机。

发布于:1年以前  |  770次阅读  |  详细内容 »

ASML CEO警告:出口管制不是可行做法,不要“逼迫中国大陆创新”

据报道,荷兰半导体设备公司ASML正看到美国对华遏制政策的负面影响。阿斯麦(ASML)CEO彼得·温宁克在一档电视节目中分享了他对中国大陆问题以及该公司面临的出口管制和保护主义的看法。彼得曾在多个场合表达了他对出口管制以及中荷经济关系的担忧。

发布于:1年以前  |  756次阅读  |  详细内容 »

抖音中长视频App青桃更名抖音精选,字节再发力对抗B站

今年早些时候,抖音悄然上线了一款名为“青桃”的 App,Slogan 为“看见你的热爱”,根据应用介绍可知,“青桃”是一个属于年轻人的兴趣知识视频平台,由抖音官方出品的中长视频关联版本,整体风格有些类似B站。

发布于:1年以前  |  648次阅读  |  详细内容 »

威马CDO:中国每百户家庭仅17户有车

日前,威马汽车首席数据官梅松林转发了一份“世界各国地区拥车率排行榜”,同时,他发文表示:中国汽车普及率低于非洲国家尼日利亚,每百户家庭仅17户有车。意大利世界排名第一,每十户中九户有车。

发布于:1年以前  |  589次阅读  |  详细内容 »

研究发现维生素 C 等抗氧化剂会刺激癌症生长和转移

近日,一项新的研究发现,维生素 C 和 E 等抗氧化剂会激活一种机制,刺激癌症肿瘤中新血管的生长,帮助它们生长和扩散。

发布于:1年以前  |  449次阅读  |  详细内容 »

苹果据称正引入3D打印技术,用以生产智能手表的钢质底盘

据媒体援引消息人士报道,苹果公司正在测试使用3D打印技术来生产其智能手表的钢质底盘。消息传出后,3D系统一度大涨超10%,不过截至周三收盘,该股涨幅回落至2%以内。

发布于:1年以前  |  446次阅读  |  详细内容 »

千万级抖音网红秀才账号被封禁

9月2日,坐拥千万粉丝的网红主播“秀才”账号被封禁,在社交媒体平台上引发热议。平台相关负责人表示,“秀才”账号违反平台相关规定,已封禁。据知情人士透露,秀才近期被举报存在违法行为,这可能是他被封禁的部分原因。据悉,“秀才”年龄39岁,是安徽省亳州市蒙城县人,抖音网红,粉丝数量超1200万。他曾被称为“中老年...

发布于:1年以前  |  445次阅读  |  详细内容 »

亚马逊股东起诉公司和贝索斯,称其在购买卫星发射服务时忽视了 SpaceX

9月3日消息,亚马逊的一些股东,包括持有该公司股票的一家养老基金,日前对亚马逊、其创始人贝索斯和其董事会提起诉讼,指控他们在为 Project Kuiper 卫星星座项目购买发射服务时“违反了信义义务”。

发布于:1年以前  |  444次阅读  |  详细内容 »

苹果上线AppsbyApple网站,以推广自家应用程序

据消息,为推广自家应用,苹果现推出了一个名为“Apps by Apple”的网站,展示了苹果为旗下产品(如 iPhone、iPad、Apple Watch、Mac 和 Apple TV)开发的各种应用程序。

发布于:1年以前  |  442次阅读  |  详细内容 »

特斯拉美国降价引发投资者不满:“这是短期麻醉剂”

特斯拉本周在美国大幅下调Model S和X售价,引发了该公司一些最坚定支持者的不满。知名特斯拉多头、未来基金(Future Fund)管理合伙人加里·布莱克发帖称,降价是一种“短期麻醉剂”,会让潜在客户等待进一步降价。

发布于:1年以前  |  441次阅读  |  详细内容 »

光刻机巨头阿斯麦:拿到许可,继续对华出口

据外媒9月2日报道,荷兰半导体设备制造商阿斯麦称,尽管荷兰政府颁布的半导体设备出口管制新规9月正式生效,但该公司已获得在2023年底以前向中国运送受限制芯片制造机器的许可。

发布于:1年以前  |  437次阅读  |  详细内容 »

马斯克与库克首次隔空合作:为苹果提供卫星服务

近日,根据美国证券交易委员会的文件显示,苹果卫星服务提供商 Globalstar 近期向马斯克旗下的 SpaceX 支付 6400 万美元(约 4.65 亿元人民币)。用于在 2023-2025 年期间,发射卫星,进一步扩展苹果 iPhone 系列的 SOS 卫星服务。

发布于:1年以前  |  430次阅读  |  详细内容 »

𝕏(推特)调整隐私政策,可拿用户发布的信息训练 AI 模型

据报道,马斯克旗下社交平台𝕏(推特)日前调整了隐私政策,允许 𝕏 使用用户发布的信息来训练其人工智能(AI)模型。新的隐私政策将于 9 月 29 日生效。新政策规定,𝕏可能会使用所收集到的平台信息和公开可用的信息,来帮助训练 𝕏 的机器学习或人工智能模型。

发布于:1年以前  |  428次阅读  |  详细内容 »

荣耀CEO谈华为手机回归:替老同事们高兴,对行业也是好事

9月2日,荣耀CEO赵明在采访中谈及华为手机回归时表示,替老同事们高兴,觉得手机行业,由于华为的回归,让竞争充满了更多的可能性和更多的魅力,对行业来说也是件好事。

发布于:1年以前  |  423次阅读  |  详细内容 »

AI操控无人机能力超越人类冠军

《自然》30日发表的一篇论文报道了一个名为Swift的人工智能(AI)系统,该系统驾驶无人机的能力可在真实世界中一对一冠军赛里战胜人类对手。

发布于:1年以前  |  423次阅读  |  详细内容 »

AI生成的蘑菇科普书存在可致命错误

近日,非营利组织纽约真菌学会(NYMS)发出警告,表示亚马逊为代表的电商平台上,充斥着各种AI生成的蘑菇觅食科普书籍,其中存在诸多错误。

发布于:1年以前  |  420次阅读  |  详细内容 »

社交媒体平台𝕏计划收集用户生物识别数据与工作教育经历

社交媒体平台𝕏(原推特)新隐私政策提到:“在您同意的情况下,我们可能出于安全、安保和身份识别目的收集和使用您的生物识别信息。”

发布于:1年以前  |  411次阅读  |  详细内容 »

国产扫地机器人热销欧洲,国产割草机器人抢占欧洲草坪

2023年德国柏林消费电子展上,各大企业都带来了最新的理念和产品,而高端化、本土化的中国产品正在不断吸引欧洲等国际市场的目光。

发布于:1年以前  |  406次阅读  |  详细内容 »

罗永浩吐槽iPhone15和14不会有区别,除了序列号变了

罗永浩日前在直播中吐槽苹果即将推出的 iPhone 新品,具体内容为:“以我对我‘子公司’的了解,我认为 iPhone 15 跟 iPhone 14 不会有什么区别的,除了序(列)号变了,这个‘不要脸’的东西,这个‘臭厨子’。

发布于:1年以前  |  398次阅读  |  详细内容 »
 相关文章
Android插件化方案 5年以前  |  237231次阅读
vscode超好用的代码书签插件Bookmarks 2年以前  |  8065次阅读
 目录