前言
代码审查是开发过程中的一个环节,顾名思义,代码审查需要一位或多位开发人员审查另一位开发人员(即代码的作者)编写的代码,以确保:
-
代码没有任何错误,没有bug,也没有问题;
-
代码符合质量与样式指南的要求和标准;
-
代码完成了所有预期功能;
-
合并代码后,代码库仍然能够正常运行,且达到更好的状态。
这就是为什么代码审查是软件开发的重要环节的原因。代码审查者担当着把关者的职责,负责决定这些代码是否能够成为代码库的一部分并进入生产环境。Google以其卓越的技术而闻名世界,他们拥有高效的代码审查标准,这些标准突出了审查代码时需要牢记的一些重点。
在Google,“代码审查的主要目的是确保Google代码库内整体的代码运行状况能够不断提升。”
—— Google工程实践文档
以下是审查代码时你需要牢记的一些重点。
1、这些代码能够提升系统整体的运行状况每次代码变更(拉取请求)都能够提升系统整体的运行状况。重点在于,即便是很小的改进,合并代码后都会提升软件或代码库的运行状况。
2、快速审查代码,并给出积极地响应和反馈首先也是最重要的一点,不可延误代码的合并。世上没有完美的代码。如果代码可以提升系统的整体运行状况,则应该立即交付这些代码。
“关键在于,世上没有完美的代码,只有更好的代码。”
—— Google工程实