只是!谷歌更新了开源代码审查规范,代码好不好一目了然。这些文档代表了Google各种最佳实践的集合。今天,谷歌开源了这套代码审查(CodeReview)规范。目前,这个CodeReview规范实际上由两套独立的文件组成:CodeReviewers指南CodeReviewStandardsWhatCodeReviewsExpecttoAchieveNavigatetheChangeListinCodeReviewsSpeedofCodeReviews如何撰写审查意见处理CodeReview回滚CLauthor'sguidetowritingagoodchangelist描述了如何构建一些小的changelists如何处理来自codereviewers的评论其中一些文档使用了谷歌的内部术语,谷歌也给出了详细的解释:CL:standsfor"changelist(changelist)",表示已提交版本控制或正在进行代码审查的单个更改。其他组通常称为“更改”或“补丁”。LGTM:意思是“对我来说看起来不错”,这是代码审阅者在批准CL时所说的。那么,CodeReviewerGuidelines审查的是什么?代码审查应查看:设计:代码是否经过精心设计并适合您的系统?功能:代码的行为是否符合作者的预期?代码的行为方式是否有利于用户?复杂性:代码可以更简单吗?其他开发人员在阅读这段代码后是否能够轻松理解并使用它?测试:代码是否有正确且设计良好的自动化测试?命名:开发人员是否为变量、类、方法等设置了人类可读的名称?注释:代码注释是否清晰有用?风格:代码是否遵循标准的写作风格?文档:开发者是否也更新了相关文档?整个代码审查指南分为很多模块,我们无法一一介绍。有兴趣的小伙伴可以详细查看。目前eng-practices在GitHub上有16.2Kstars和1.6KForks(GitHub地址:https://github.com/google/eng-practices/blob/master/review/index.md)这个项目的最新更新显示那是昨天的事,其中一个文件发生了变化,包括2个增加和2个删除。具体更新如下:
