本文翻译来自google的代码审查 工程实践。
介绍
代码审查是一段代码作者以外的其他人检查该代码的过程。
在 Google,我们使用代码审查来维护我们的代码和产品的质量。
本文档是对 Google 代码审查流程和政策的规范描述。
本页概述了我们的代码审查流程。本指南中还有另外两个大型文档:
代码审查员寻找什么?
代码审查应该关注:
- 设计:代码是否经过精心设计并适合您的系统?
- 功能:代码的行为是否符合作者的预期?代码的行为方式是否对用户有利?
- 复杂性:代码可以更简单吗?将来遇到此代码时,其他开发人员是否能够轻松理解和使用此代码?
- 测试:代码是否具有正确且设计良好的自动化测试?
- 命名:开发人员是否为变量、类、方法等选择了清晰的名称?
- 评论:评论是否清晰有用?
- 风格:代码是否遵循我们的 风格指南?
- 文档:开发者是否也更新了相关文档?
有关详细信息,请参阅如何进行代码审查。
挑选最佳评论者
一般来说,您希望找到能够在合理时间内回复您的评论的最佳评论者。
最好的审阅者是能够对您正在编写的代码进行最彻底和正确审阅的人。这通常意味着代码的所有者,他可能是也可能不是 OWNERS 文件中的人。有时这意味着要求不同的人查看 CL 的不同部分。
如果您找到理想的审阅者但他们不可用,您至少应该在更改时抄送他们。
亲自审查(和结对编程)
如果您与有资格对其进行良好代码审查的人对一段代码进行了结对编程,那么该代码被认为是经过审查的。
您还可以进行面对面的代码审查,审查员提出问题,而更改的开发人员仅在与他们交谈时才发言。
也可以看看