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


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

  • 代码没有任何错误 , 没有bug , 也没有问题;
  • 代码符合质量与样式指南的要求和标准;
  • 代码完成了所有预期功能;
  • 合并代码后 , 代码库仍然能够正常运行 , 且达到更好的状态 。
这就是为什么代码审查是软件开发的重要环节的原因 。 代码审查者担当着把关者的职责 , 负责决定这些代码是否能够成为代码库的一部分并进入生产环境 。
Google以其卓越的技术而闻名世界 , 他们拥有高效的代码审查标准 , 这些标准突出了审查代码时需要牢记的一些重点 。
在Google , “代码审查的主要目的是确保Google代码库内整体的代码运行状况能够不断提升 。 ”
—— Google工程实践文档
以下是审查代码时你需要牢记的一些重点 。
代码审查标准:
Google 鼓励的 13 条代码审查标准,建议收藏文章插图
这些代码能够提升系统整体的运行状况每次代码变更(拉取请求)都能够提升系统整体的运行状况 。 重点在于 , 即便是很小的改进 , 合并代码后都会提升软件或代码库的运行状况 。
Google 鼓励的 13 条代码审查标准,建议收藏文章插图
快速审查代码 , 并给出积极地响应和反馈
首先也是最重要的一点 , 不可延误代码的合并 。 世上没有完美的代码 。 如果代码可以提升系统的整体运行状况 , 则应该立即交付这些代码 。
“关键在于 , 世上没有完美的代码 , 只有更好的代码 。 ”
—— Google工程实践文档
如果手头没有紧急任务 , 那么请在代码提交上来后立即进行审查 。 响应拉取请求的时间最长不得超过一个工作日 。 一天之内 , 应针对一次拉取请求完成多轮的部分或完整的代码审查 。
Google 鼓励的 13 条代码审查标准,建议收藏文章插图
在代码审查的过程中开展教育和启发在代码审查的过程中 , 应尽可能通过共享知识和经验提供指导 。
Google 鼓励的 13 条代码审查标准,建议收藏文章插图
审查代码应遵循标准请始终牢记 , 样式指南、编程标准以及相关的文档应该作为代码审查的绝对权威 。 例如 , 制表符与空格的使用应保持一致 , 此时你可以引用编程约定 。
如果你选用的是Java , 那么以下文章可能会有所帮助 , 文中总结了大型科技公司Java编程的最佳实践:《Java编程最佳实践摘要》()
Google 鼓励的 13 条代码审查标准,建议收藏文章插图
解决代码审查冲突解决代码审查冲突时 , 应遵循样式指南以及编程标准中商定的最佳实践 , 并征求其他拥有更多产品领域知识和经验的人的建议 。
Google 鼓励的 13 条代码审查标准,建议收藏文章插图
如果你的意见是可选或不怎么重要的 , 请在注释中说明 , 然后由作者来决定是解决还是略过 。
作为代码审查者 , 在没有样式指南或编程标准的情况下 , 你至少可以建议此次代码变更与其余代码库保持一致 。
Google 鼓励的 13 条代码审查标准,建议收藏文章插图
演示UI变更是代码审查的一部分
如果代码变更涉及用户界面变化 , 则除了代码审查外 , 还需要提供演示 , 确保界面符合预期且与界面设计一致 。
对于前端代码变更 , 你需要进行演示 , 或确保代码变更包括必要的UI自动化测试 , 以验证添加或更新的功能 。
Google 鼓励的 13 条代码审查标准,建议收藏文章插图
确保代码审查中包含了所有测试
除非遇到紧急情况 , 否则拉取请求应包含所有必要的测试 , 例如单元测试、集成测试以及端到端测试等 。
这里所说的紧急情况指的是 , 某个需要尽快修复的bug或安全漏洞 , 而测试可以等到以后再添加 。 在这种情况下 , 请确保创建了适当的票证/问题 , 并确保有人负责在完成热修复或部署后立即完成测试 。