View on GitHub

google_eng_practice

谷歌(Google)工程实践文档(Google's Engineering Practices documentation)

代码审核指南

目录

介绍

开发者写完代码后,让其他人来审视这些代码,这个过程称为代码审核(译者注:也译为“代码评审”或“代码审视”)。

在 Google,我们通过代码审核来保证代码质量,进而保证产品质量。

此文档是 Google 代码审核审核流程和政策的规范说明。

本节对代码审核过程作简要介绍,后面的两篇文档会做更详细的说明:

代码审核者应该看什么?

代码审核者应该关注以下事项:

详情可参见文档:怎样做代码审核

挑选最好的代码审核者

一般来讲,你一定会找最好的代码审核者来帮你审核代码,这个人应该在你期望的时间内有能力对审核工作负责。

如果若干人能对你的代码给出正确的反馈意见,那么最好的审核者就是这些人中最有见地的那个。他可能是你正在修改的代码的原始作者,也可能不是。有时候,一个代码审核者无法覆盖整个 CL,他们只能审核其中一部分,这种情况就需要多位审核者(这并不意味着当一个审核者能覆盖所有代码时,就只需要一个审核者),以确保能覆盖所有代码。

如果最理想的代码审核者无法帮你审核,至少应该抄送给他(或者把他加到可选的审核者名单里去)。

面对面审核

如果你正在与一个人结对编程,你的伙伴已经对代码做过细致审核,那么这段代码可以认为是审核通过的。

你还可以与代码审核者进行面对面审核。当有疑问时,审核者提问,开发者回答。

参考