Google 鼓励的 13 条代码审查标准,建议收藏!

代码审查规范.doc 检查点、检查流程、审查流程图(包括具体流程) 立即下载

点击上方“芋道源码”,选择“设为星标”

管她前浪,还是后浪?

能浪的浪,才是好浪!

每天 8:55 更新文章,每天掉亿点点头发...

源码精品专栏

 

来源:Rafiullah Hamedy


以下为译文:

在本文中,我们将简要介绍13条代码审查标准,希望能够通过这些标准极大地帮助改善软件的质量,同时让开发人员保持心情愉悦。

代码审查是开发过程中的一个环节,顾名思义,代码审查需要一位或多位开发人员审查另一位开发人员(即代码的作者)编写的代码,以确保:

  • 代码没有任何错误,没有bug,也没有问题;

  • 代码符合质量与样式指南的要求和标准;

  • 代码完成了所有预期功能;

  • 合并代码后,代码库仍然能够正常运行,且达到更好的状态。

这就是为什么代码审查是软件开发的重要环节的原因。代码审查者担当着把关者的职责,负责决定这些代码是否能够成为代码库的一部分并进入生产环境。

Google以其卓越的技术而闻名世界,他们拥有高效的代码审查标准,这些标准突出了审查代码时需要牢记的一些重点

在Google,“代码审查的主要目的是确保Google代码库内整体的代码运行状况能够不断提升。” —— Google工程实践文档

以下是审查代码时你需要牢记的一些重点。

代码审查标准:

这些代码能够提升系统整体的运行状况

每次代码变更(拉取请求)都能够提升系统整体的运行状况。重点在于,即便是很小的改进,合并代码后都会提升软件或代码库的运行状况。

快速审查代码,并给出积极地响应和反馈

首先也是最重要的一点,不可延误代码的合并。世上没有完美的代码。如果代码可以提升系统的整体运行状况,则应该立即交付这些代码。

“关键在于,世上没有完美的代码,只有更好的代码。” —— Google工程实践文档

如果手头没有紧急任务,那么请在代码提交上来后立即进行审查。响应拉取请求的时间最长不得超过一个工作日。一天之内,应针对一次拉取请求完成多轮的部分或完整的代码审查。

在代码审查的过程中开展教育和启发

在代码审查的过程中,应尽可能通过共享知识和经验提供指导。

审查代码应遵循标准

请始终牢记,样式指南、编程标准以及相关的文档应该作为代码审查的绝对权威。例如,制表符与空格的使用应保持一致,此时你可以引用编程约定。

如果你选用的是Java,那么以下文章可能会有所帮助,文中总结了大型科技公司Java编程的最佳实践:《Java编程最佳实践摘要》(https://rhamedy.medium.com/a-short-summary-of-java-coding-best-practices-31283d0167d3)

解决代码审查冲突

解决代码审查冲突时,应遵循样式指南以及编程标准中商定的最佳实践,并征求其他拥有更多产品领域知识和经验的人的建议。

图片

如果你的意见是可选或不怎么重要的,请在注释中说明,然后由作者来决定是解决还是略过。

作为代码审查者,在没有样式指南或编程标准的情况下,你至少可以建议此次代码变更与其余代码库保持一致。

演示UI变更是代码审查的一部分

如果代码变更涉及用户界面变化,则除了代码审查外,还需要提供演示,确保界面符合预期且与界面设计一致。

对于前端代码变更,你需要进行演示,或确保代码变更包括必要的UI自动化测试,以验证添加或更新的功能。

确保代码审查中包含了所有测试

除非遇到紧急情况,否则拉取请求应包含所有必要的测试,例如单元测试、集成测试以及端到端测试等。

这里所说的紧急情况指的是,某个需要尽快修复的bug或安全漏洞,而测试可以等到以后再添加。在这种情况下,请确保创建了适当的票证/问题,并确保有人负责在完成热修复或部署后立即完成测试。

图片

我们绝对不可以跳过测试。如果时间有限,某些目标有无法实现的风险,那么解决方案不是跳过测试,而是限定可交付成果的范围。

不要为了代码审查打断手头的工作

如果你正在专心致志地工作,那么请不要打断自己,因为你需要花费很长时间才能重新投入工作。换句话说,打断专心工作的开发人员所付出的代价远远超过了让开发人员等待代码审查。你可以在休息(午餐或咖啡等)过后,进行代码审查。

图片

大多数时候,整个代码审查以及代码的合并无法在一天内完成。重要的是迅速给作者一些反馈。例如,虽然可能无法完成完整的审查,但你可以快速指出一些有待探讨的地方。这可以极大地降低代码审查期间的挫败感。

审查所有代码,不要做任何假设

你需要审查提交上来的每一行代码。不要对人工编写的类和方法做任何假设,而且应该确保你理解代码在做什么。

图片

确保你理解正在审核的代码。如果不理解,则请作者澄清或提供代码演示和解释。如果你不具备审核部分代码的资格,则请其他有资格的开发人员代为审查。

审查代码时需要保持大局观

从更广阔的视野来看待代码变更会更有帮助。例如,某个文件被修改,并添加了4行新代码。请不要只看这4行代码,你应该考虑审查整个文件,并检查新添加的内容。它们是否会降低现有代码的质量?它们是否会导致现有功能成为重构的候选对象?

如果不在函数/方法或类的背景下审查添加的代码,则随着时间的流逝,你将会得到一个面临无法维护、纠缠不清、不易于测试等问题的类,而且这个类很难扩展或重构。

请记住,即便是微不足道的改进,随着时间的推移,也可能导致产品出现缺陷,同样,即便是轻微的代码降级或技术负债也可能在日积月累下导致产品难以维护和扩展。

在代码审查期间认同和鼓励出色的工作

如果看到出色的代码变更,请别忘了大力表扬和鼓励作者。代码审查的目的不仅仅是发现错误,而且还应该鼓励和指导开发人员出色的工作。

在代码审查期间应保持谨慎、尊重、友善和思路清晰

在代码审查期间,你应该保持友善、思路清晰、有礼貌和尊重别人,这一点至关重要,同时也要给予作者清晰的反馈和积极的帮助。在审查代码时,你需要做到对事不对人,即对代码做出评论,而非开发人员。

详细解释代码审查的意见,并注意尺度

每当代码审查意见提出替代方案或指出某些问题时,重要的是你需要解释其中的原因,并根据个人的知识和经验提供示例,以帮助开发人员理解为何你的建议能够提升代码质量。在建议修改或变更代码时,你需要在如何指导作者修改代码方面找到适当的平衡。例如,我更喜欢指导、解释、提示或建议,而不是整个解决方案。



欢迎加入我的知识星球,一起探讨架构,交流源码。加入方式,长按下方二维码噢:

已在知识星球更新源码解析如下:

最近更新《芋道 SpringBoot 2.X 入门》系列,已经 20 余篇,覆盖了 MyBatis、Redis、MongoDB、ES、分库分表、读写分离、SpringMVC、Webflux、权限、WebSocket、Dubbo、RabbitMQ、RocketMQ、Kafka、性能测试等等内容。

提供近 3W 行代码的 SpringBoot 示例,以及超 4W 行代码的电商微服务项目。

获取方式:点“在看”,关注公众号并回复 666 领取,更多内容陆续奉上。

兄弟,艿一口,点个赞!????

谷歌是如何做代码审查的 在上一篇文章中提到过,我已经不在Google工作了。我还没有想清楚应该去哪里—有两三个非常好的工作机会摆在我面前。因为在这段做决定时间里,我不再受雇于任何人,我想可以写一些专业性的东西,一些很有趣,但也会在同事和管理工作中导致关系紧张的东西。   在上一篇文章中提到过,我已经不在Google工作了。我还没有想清楚应该去哪里—有两三个非常好的工作机会摆在我面前。因为在这段做决定时间里,我不再受雇于任何人,我想可以写一些专业性的东西,一些很有趣,但也会在同事和管理工作中导致关系紧张的东西。   Google是一个非常优秀的公司。他们做出了很多令人称赞的东西—既是公司外部,人们可以看到的东西,也是公 立即下载

相关推荐

华为等安卓手机的vcf无法导入苹果的iCloud 通讯录

华为等安卓手机的vcf无法导入苹果的iCloud 通讯录

Guocean 8622

​Google 鼓励的 13 条代码审查标准,建议收藏!

作者 |Rafiullah Hamedy译者 |弯月,责编 | 杨碧玉头图 | 优快云 下载自东方 IC出品 | 优快云(ID:优快云news)以下为译文:在本文中,我们将简要...

程序人生的博客 764

5G NR切换测量事件解析:从A1到B2的实战应用指南

本文深入解析5G NR切换测量事件,从A1到B2的实战应用指南。详细介绍了系统内切换事件(A1-A6)和系统间切换事件(B1-B2)的触发条件与配置建议,帮助优化网络性能。通过实际案例分享,展示如何调整参数提升切换成功率和降低乒乓切换率,适用于5G网络优化工程师。

tcp8optimizer的博客 515

Google Play 机审浅析 (马甲包思路)

从提交aab那一刻 你的aab到达了GP审核系统的后台,进行审核队列排队,首先提取概要信息(例如manifest信息 签名信息等),拿到这个特征 进入wait状态,持续N天(目的是为了让这个ab包和提交日后N天内提交的包先进行一次概要信息对比)。

Lojjkey的博客 5969

【GNSS/Linux】BKG Ntrip Client (BNC) 的编译与安装

【GNSS/Linux】BKG Ntrip Client (BNC) 的编译与安装 1. BNC软件 1.1 软件介绍 The BKG Ntrip Client (BNC) is an Open Source multi-stream client program designed for a variety of real-time GNSS applications. It was primarily designed for receiving data streams from any Ntrip

小马甲的新马甲 7809

(1)大蚂蚁即时通讯

即时通讯软件BigAnt(大蚂蚁)是杭州艾朴软件推出的一个”企业级”的即时通讯平台。该平台专为企业,其他企事业单位和政府单位而设计,目的就是为了增强内部沟通能力,提高内部员工的工作效率;同时服务器就直接置于单位内部,所有信息由单位自己管理,让单位以更安全、更可伸缩和更易于管理的方式灵活方便地使用协同和通信服务的功能! BigAnt(大蚂蚁)即时通讯软件包括服务器端和客户端。客户端功能包括单位

少安的砖厂 2240

google paly过审问题汇总

如果您的App包含这些不当的或者令人反感的内容,同时又没有完善的审核、过滤及举报机制,那么您的应该在提交审核时很可能被拒。如果您的应用未能顺利上架或更新,而是遇到被拒、下架、暂停、警告中的其中一种情况,那么您需要了解Google 可能拒绝您的应用的一些主要原因,以及您可以采取哪些措施来避免此类问题。如果需要满足特定条件(例如,提供登录凭据、基于登录信息详情、取得会员资格、在特定地点或进行其他形式的身份验证)才能访问您的整个应用或应用的某些部分,您必须提供所有必需的详细说明,以便用户访问您的应用。

sandy_chen_onlyone的博客 4792

动态库加载失败终极指南:从libbz2.so.1错误看Linux依赖管理本质

本文以经典的libbz2.so.1加载错误为例,深入剖析Linux动态链接库管理的核心机制。文章不仅提供从ldd检查、符号链接创建到LD_LIBRARY_PATH设置等实战解决方案,更系统性地讲解了动态链接器的寻库路径、版本管理及依赖问题预防策略,帮助开发者从根本上理解和掌握Linux依赖管理本质。

weixin_29212429的博客 451

Google的工程实践指南(上):代码审核指南

在代码审核的长期实践中,我们总结出了最佳实践,并在此基础上整理出了这些建议。整篇文档各部分的衔接性并不大,在阅读时,你可以选取自己感兴趣的部分,而不必按顺序阅读全文。当然,我们仍旧建议你按顺序通读全篇,你会发现这份文档对你非常有用。 一. 代码审核的标准 标准 代码审核的目的是为了保证代码库中的代码质量持续改进,代码审核的工具和流程都是为了实现这个目的而设计。 为了达到目标,我们需要权衡得失。 首先,开发人员必须能在任务上 取得进展 。如果从没向代码库提交代码,那么代码库就不会改善。同时,如果

所寫即所思|一个阿里质量人对测试的所感所悟。 787

R语言实战:5分钟搞定NHANES数据库的加权分析与可视化(附完整代码)

本文提供了一份R语言实战指南,帮助研究者在5分钟内完成NHANES数据库的加权分析与可视化。通过详细的代码示例,涵盖数据获取、清洗、加权分析和可视化全流程,特别适合公共卫生和流行病学研究者快速掌握复杂抽样数据的处理方法。

www00的博客 258

UG\NX二次开发 一个创建小平面体的例子

介绍。

王牌飞行员_里海的博客 446

Google 代码审查指南

代码审查是除了代码作者之外,其他人检查代码的过程。Google 通过 Code Review 来维护代码和产品质量。此文档是 Google Code Review 流程和政策的规范说明。代码审查者指南:针对代码审查者的详细指南。代码开发者指南:针对 CL 开发者的的详细指南。代码设计精良。该功能对代码用户是有好处的。任何 UI 变更都是合理的且看起来是好的。其中任何并行编程都是安全的。代码并不比它需要的复杂。开发人员没有实现他们将来可能需要,但不知道他们现在是否需要的东西。

heshihu2019的博客 830

思博伦仪表打流测试使用总结

下图红框中的checkbox为选中状态时,表示该流会携带测试仪做一些分析,包括时延和乱序等信息时需要的一些字节,当改选项选中时,如配置IPv4的TCP流,最小字节长度必须为78字节;如果需要64字节的TCP流,改选项必须不选中;

陌上花开缓缓归以的博客 1472

Google 推荐和鼓励的 13 条代码审查标准,建议收藏!

以下为译文:在本文中,我们将简要介绍13条代码审查标准,希望能够通过这些标准极大地帮助改善软件的质量,同时让开发人员保持心情愉悦。代码审查是开发过程中的一个环节,顾名思义,代码审查需要一...

emprere的博客 271

文档:亲测可用解决vnc灰屏,黑屏,鼠标大黑叉情况

主要解决vnc-viewer灰屏,黑屏,鼠标大黑叉等现象,详细见文档。

温度PID控制PLC程序

温度PID稳定控制程序,适用于欧姆龙PLC,对其他PLC也具有很大参考价值

idea拉取代码冲突_Google 鼓励的 13 条代码审查标准,建议收藏!

作者 |Rafiullah Hamedy译者 |弯月,责编 | 杨碧玉头图 | 优快云 下载自东方 IC出品 | 优快云(ID:优快云news)以下为译文:在本文中,我们将简要介绍13条代码审查标准,希望能够通过这些标准极大地帮助改善软件的质量,同时让开发人员保持心情愉悦。代码审查是开发过程中的一个环节,顾名思义,代码审查需要一位或多位开发人员审查另一位开发人员(即代码的作者)...

weixin_39535217的博客 198

迈瑞BS系列全自动生化分析仪LIS协议接口手册(内含HL7和ASTM)

迈瑞BS系列全自动生化分析仪LIS协议接口手册,内含HL7和ASTM)

Google鼓励的13条代码审查标准 [建议收藏]

如何在代码审查方面表现出色在本文中,我们将简要介绍13种代码审查标准,这些标准可以极大地帮助改善软件的运行状况并保持开发人员满意。顾名思义,代码审查是一个过程,其中一个或多个开发人员审查...

DevOps持续集成的博客 962

Google鼓励的13条代码审查标准

如何在代码审查方面表现出色在本文中,我们将简要介绍13种代码审查标准,这些标准可以极大地帮助改善软件的运行状况并保持开发人员满意。顾名思义,代码审查是一个过程,其中一个或多个开发人员审查或...

DevOps持续集成的博客 257

代码复查 code review 规范

在本文中,我们将简要介绍13条代码审查标准,希望能够通过这些标准极大地帮助改善软件的质量,同时让开发人员保持心情愉悦。 代码审查是开发过程中的一个环节,顾名思义,代码审查需要一位或多位开发人员审查另一位开发人员(即代码的作者)编写的代码,以确保: 代码没有任何错误,没有bug,也没有问题; 代码符合质量与样式指南的要求和标准; 代码完成了所有预期功能; 合并代码后,代码库仍然能够正常运行,且达到更好的状态。 这就是为什么代码审查是软件开发的重要环节的原因。代码审查者担当着把关者的职责,负责决定这些代码是

zhaoyang10的专栏 542
上一篇: K8S知道,K9S呢?
下一篇: Slf4j 包老冲突,每次排查半天,是什么原因?怎么解决?
公众号-芋道源码
博客等级 码龄10年 1639粉丝 377原创
评论 1
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付:10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值