引领先锋|Google鼓励的13条代码审查标准


引领先锋|Google鼓励的13条代码审查标准如何在代码审查方面表现出色在本文中 , 我们将简要介绍13种代码审查标准 , 这些标准可以极大地帮助改善软件的运行状况并保持开发人员满意 。
顾名思义 , 代码审查是一个过程 , 其中一个或多个开发人员审查或筛选另一位开发者(作者)编写的代码 , 以确保:

  • 代码没有任何错误或问题 。
  • 符合所有质量要求和标准 。
  • 代码执行了预期的测试 。
  • 合并后 , 它将使代码库的运行状况保持更好 。
这就是为什么代码审查是软件开发的关键部分的原因 。 代码审阅者充当代码库管理员 , 负责确定代码是否处于要成为代码库的一部分并进入生产的状态 。
Google以其卓越的技术而著称 , 它们具有有效的代码审查标准 , 这些标准似乎突出了审查代码时要记住的一些要点 。 在Google , 代码审查的主要目的是确保Google代码库的整体代码运行状况随着时间的推移而不断改善 。
这是您在查看更改列表时要记住的事项列表 。
审查标准1.该代码改善了系统的整体运行状况每个更改列表(Pull Request)都会改善系统的整体运行状况 。 想法是 , 由于进行了如此小的改进 , 每次合并后 , 软件或代码库的运行状况都会得到改善 。
2.快速的代码审查 , 响应和反馈首先 , 不要延迟推送(合并)更好的代码 。 不要指望代码是完美的 。 如果它的状况可以改善系统的整体运行状况 , 则请推送 。
“这里的关键是没有'完美'的代码 , 只有更好的代码 。 ”
如果您不在一项重点任务的中间 , 那么请在代码完成后立即进行检查;但是 , 一个工作日是响应拉取请求所需的最长时间 。 预计变更列表将在一天之内获得多轮的部分/完整代码审查 。
3.在代码审查期间进行教育和启发通过尽可能共享知识和经验 , 在代码审查期间提供指导 。
4.审查代码时遵循标准始终牢记 , 编码标准此类文档是代码审查期间的绝对权威 。 例如 , 要在制表符和空格之间保持一致性 , 可以引用编码约定 。
5.解决代码审查冲突通过遵循样式指南和编码标准文档中商定的最佳实践 , 并寻求其他在产品领域具有更多知识和经验的人的建议 , 来解决冲突 。 根据严重性 , 处理冲突有所不同 。
引领先锋|Google鼓励的13条代码审查标准如果您的评论是可选的或次要的 , 请在评论中进行说明 , 然后由作者决定是解决还是忽略它们 。 作为代码审阅者 , 您至少可以建议在没有样式指南或编码标准的情况下 , 更改列表(请求)与其余代码库保持一致 。
6.演示UI更改是代码审查的一部分如果更改列表(Pull Request)更改了用户界面 , 则除了代码查看之外 , 还必须进行演示以确保外观上的所有外观均符合预期并与模拟匹配 。
对于前端变更列表(Pull Request) , 始终建议进行演示/演练 , 或确保变更列表还包括必要的UI自动化测试 , 以验证添加/更新的功能 。
7.确保代码审查伴随所有测试除非紧急情况 , 否则拉取请求(更改列表)应伴随所有必要的测试 , 例如单元 , 集成 , 端到端等 。
紧急情况可能是需要尽快修复的错误或安全漏洞 , 以后可以添加测试 。 在这种情况下 , 请确保创建了适当的问题 , 并确保有人在完成热修复或部署后立即拥有所有权才能完成 。
引领先锋|Google鼓励的13条代码审查标准没有足够的理由跳过测试 。 如果由于时间限制 , 某些目标有无法实现的风险 , 那么解决方案不是跳过测试 , 而是要对可交付成果进行范围界定 。


推荐阅读