作者：Rafiullah Hamedy

翻译 | 弯月，编辑 | 杨碧玉

头图 | 东方IC提供CSDN下载

出品 | CSDN（ID：CSDNnews）

以下是翻译的版本：

在本文中，我们将简要介绍13个代码审查标准，旨在通过这些标准极大地提升软件质量，并让开发人员保持愉悦的心情。

代码审查是开发过程中的一个重要环节。顾名思义，代码审查需要由一位或多位开发人员对另一位开发人员（即代码的作者）编写的代码进行仔细检查，以确保以下几点：

• 代码毫无瑕疵，没有任何漏洞，也没有任何隐患。

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

• 代码已经实现了所有预期的功能。

• 代码合并后，代码库仍然能够顺利运行，并且达到了更优化的状态。

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

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行代码。相反，我们应该全面审查整个文件，并检查新增内容是否会降低现有代码的质量。此外，还需要考虑这些变动是否会导致现有功能成为重构的候选对象。

如果在函数/方法或类的背景下没有审查添加的代码，随着时间的推移，你将面临一个无法维护、混乱不清、难以测试等问题的类，并且这个类很难进行扩展或重构。

请谨记，即使是微小的改进，在时间的推移下也可能导致产品出现缺陷。同样地，轻微的代码降级或技术负债也有可能在积累过程中导致产品难以维护和扩展。

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

当你发现出色的代码变更时，请不要忘记给予作者充分的赞扬和鼓励。代码审查的目标不仅仅是为了发现错误，更应该是为了激励和指导开发人员做出卓越的工作。

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

在进行代码审查时，保持友善、思路清晰、有礼貌和尊重他人是非常重要的。同时，给予作者明确的反馈和积极的帮助也是必要的。在审查代码时，请记住对事不对人，即针对代码进行评论而不是开发人员本身。

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

当代码审查意见提出替代方案或指出问题时，解释原因并举例说明是至关重要的。通过个人知识和经验，向开发人员阐明你的建议如何提升代码质量。

当提出修改或更改代码的建议时，你需要在如何引导作者修改代码方面找到适当的平衡。举个例子，我更倾向于提供指导、解释、提示或建议，而不是直接给出整个解决方案。

非常感谢您的阅读，希望这篇文章能够让您喜欢。如果您有任何意见或建议，欢迎在下方留言。

以下是原文的改写版本： 13个受Google启发的代码审查标准。原文链接：https://medium.com/better-programming/13-code-review-standards-inspired-by-google-6b8f99f7fd67

本文为CSDN翻译，转载请务必注明出处。

更多精彩推荐

☞不愧是你！Python 之父退休太无聊，进微软搞开源！☞行业 AI 落地新范式，华为云下午茶等你来聊知识计算☞华为定义5.5G网络；阿里巴巴美股投资者发起集体诉讼；Kaldi核心算法K2 0.1版本发布|极客头条☞64岁Python之父退休失败，正式加入微软搞开源

☞如何破解“中国开源拿来主义”？包云岗的几点分析☞2020年，区块链和加密领域的女性数量激增

点分享点点赞点在看

标签： 谷歌商店上架 代码 文案