[引]谷歌代码评审开发者指南

本文转自：关于代码评审(CodeReview)那些不得不说的事儿-腾讯云开发者社区-腾讯云 (tencent.com)

如何写出对CodeReview友好的代码

程序写出来是给人看的，附带能在机器上运行。 ——Harold Abelson

 

提升代码质量

  假如将一个系统比作一个生命体，一行行代码比作一个个细胞，不好的设计宛如癌细胞，会逐渐扩散，终将杀死系统。而CodeReview的过程就像是T细胞吞噬掉癌细胞，保证系统的健康成长。让系统有更长久的生命力。

没有人Review的代码，其代码水准就是写代码人的水准，而被一个团队Review过的代码，它的水准将接近甚至超过整个团队的最高水准。

 

 

 

 

 

 

eng-practices-cn/review/index.md at master · xindoo/eng-practices-cn · GitHub

 

代码评审开发者指南

介绍

代码评审是一些人提交一些代码片段，供另外一些人审阅的流程。
在谷歌，我们都是通过代码评审来保证代码和产品的质量。
这篇文档是对谷歌代码评审流程和策略的权威描述。
这一页是我们代码评审过程的概述。这篇指南其他有两个大的部分，分别是：

• 评审者指南: 代码评审者的详细指南。
• 开发者指南: 提交代码评审的开发者的详细指南。

代码评审者需要关注什么？

代码评审者需要关注：

• 设计： 代码是否设计良好并且适合你们的系统？
• 功能性: 代码功能是否和开发者预期一致？这种方式是否对用户友好？
• 复杂性: 代码能不能更简单？ 其他开发者能否快速理解并在未来很容易地使用这段代码？
• 测试: 这段代码是否有正确和设计良好的自动化测试样例？
• 命名: 开发者有没有正确地对变量、类、方法等命名？
• 注释: 注释是否清晰有用？
• 代码风格: 代码风格是否遵循谷歌代码风格指南?
• 文档: 开发者是否更新了相关文档？

参考 代码评审者指南 获取更多信息。

挑选最适合的代码评审者

通常而言，你都希望找个一个最合适的评审者在合理的时间里对你的变更作出评审。
最合适的评审者是那些能对你代码做出最全面最准确评价的人，一般情况下都是代码的维护者(他可能在所有者列表里也有可能不在)。 有时这意味着要不同的人阅读不同的部分。
如果你找到理想的评审者但他没有时间，你也至少应该抄送他。

亲自评审

如果你是和某个合格的代码评审者结对写的代码，那么这段代码可以认为已经通过评审了。
你也可以以问答的方式亲自参与代码评审。

参见

• 评审者指南: 代码评审者的详细指南。
• 开发者指南: 提交变更评审的开发者的详细指南。
  • eng-practices-cn/review/reviewer/index.md at master · xindoo/eng-practices-cn · GitHub

  • 如何做代码评审？

    本节中介绍了基于长期经验总结的代码评审最佳实践。所有内容都在同一个章节里，但被分为了好多子章节。虽然你不必通读一遍，但认真看一遍对你自己和整个团队都会有很大的益处。

    • 代码评审的标准
    • 代码评审应该关注什么？
    • 代码评审的步骤
    • 代码评审的速度
    • 在代码评审中如何写评论
    • 处理代码评审中的反驳

    参见开发者指南, 为开发者提供了详细的代码评审指南。