Google: 关于代码审查的建议?
发布时间
阅读量:
阅读量
导语:Google 最近发布了一份与代码审查相关的工程实践文档,内容涉及Google工程师在进行代码审查时的具体操作方式及相应指南。笔者将其翻译为中文,供读者参考学习。
原文地址: https://google.github.io/eng-practices/review/reviewer
本文的术语说明:
cr: 代码审查
cl: 变更列表,即此次修改的内容
reviewer: 进行代码审查的人员
nit: 源自nitpick,意指对细节过分挑剔
作者:即此次CL的开发者,在原文中使用author一词来指代开发者。
若觉得文章篇幅较长,可直接跳至文末查看总结部分。
cr的标准
cr(Code review)的核心目标在于保障Google代码库的质量不断提升。围绕这一目标,所有相关的工具与流程皆是为此而设计。为了实现该目标,必须进行一系列权衡与取舍。
首先,开发人员需要在各自负责的任务上取得进展。如果从未向代码库提交过任何改进内容,则代码库将无法得到提升。此外,若一个reviewer使cr变得难以执行,则开发人员在未来可能也会失去改进的动力。
另一方面,reviewer有责任确保每一个变更列表(以下简
全部评论 (0)
还没有任何评论哟~
