热透新闻
谷歌内部代码规范被公布,顶级程序员是如何进行代码审
发布日期:2020-09-25 03:21   来源:未知   阅读:

CL 描述是进行了哪些更改以及为何更改的公开记录。CL 将作为版本控制系统中的永久记录,可能会在长时期内被除审查者之外的数百人阅读。

写好 CL 描述

他们建立了一套通用的工程实战指南,差不多囊括了所有编程语言与各种类型的项目,被称为世界上最先进的源代码管理/测试/审核/提交系统。而且,谷歌还将其中的代码评审(Code Review)规范在Github上开源了出来,它代表了谷歌最佳实战经验的集合,千万不要错过。

前者主要为你讲解代码审查的几项标准与要点,后者则是教会你如何使用 CL维护好代码审查的基本流程。

谷歌作为世界上数一数二的科技公司,其内部代码规范一直被当做行业模板。

开发者将来会根据描述搜索您的 CL。有人可能会仅凭有关联性的微弱印象,但没有更多具体细节的情况下,来查找你的改动。如果所有重要信息都在代码而不是描述中,那么会让他们更加难以找到你的 CL 。

谷歌将这份指南主要拆分为两大块:代码审查者指南代码开发者指南

CL 描述的第一行应该是关于这个 CL 是做什么的简短摘要,后面跟一个空白行。这是将来大多数的代码搜索者在浏览代码的版本控制历史时,最常被看到的内容,因此第一行应该提供足够的信息,以便他们不必阅读 CL 的整个描述就可以获得这个 CL 实际上是做了什么的信息。

首行正在做什么的简短摘要完整的句子,使用祈使句后面跟一个空行

代码开发者指南里面包含了三篇文章:写好 CL 描述小型CL如何处理审查者的评论

CL是谷歌的内部术语代表“变更列表(changelist)”,表示已提交到版本控制或正在进行代码审查的自包含更改。有的组织会将其称为“变更(change)”或“补丁(patch)”。

谷歌工程实践指南

其中代码开发者指南的内容为开发人员进行代码审查的最佳实践。这些指南可帮助开发人员更快地完成审核并获得更高质量的结果。