最近中秋假期,想必大家都玩的非常愉快,就在大家 happy 的这几天期间,Google 公开了两个文档,我感觉作为程序员和工程师的你们非常有必要了解一下。
这两份文档是谷歌的工程实践文档。而且文档的内容都是跟 code review 相关的内容,里面包含了 Google 工程师如何进行 code view 的内容,以及 code view 指南。
第一份文档是:
The CL author’s guide to getting through code review
简单来讲就是CL 作者指南去指导通过代码审查。那么 CL 是什么意思呢?就是 change list ,变更记录和日志的意思。
这个指南可帮助您更快地完成代码审核并获得更高质量的结果。适用于每个Google开发人员,阅读这份指南非常有帮助。
里面包含了三篇文章:
- 写出好的 CL 描述
- Small CLs,小的,简单的 CL ,为什么需要写简单的,小的 CL 呢?里面文章中给出了具体的答案(比如可以 review 的更快,更直接,如果被拒绝,减少浪费的工作,可以减少引入的 bug 等等)。
- 如何处理 reviewer 者的评论?
文档地址:https://Google.github.io/eng-practices/review/developer/
第二份文档:
How to do a code review
这个不用翻译了,就是如何去做 code review 。
这份文档中包含有关进行代码审查的最佳方式的建议。是一个非常完整的文档,分为许多单独的部分。阅读这个文档,对于大家来看,肯定会非常有帮助,绝对让大家受益匪浅的一件事。
里面包含了 6 篇文章,分别是:
- 代码审查标准
- 在代码审查中需要注意什么
- 在审查中导航CL
- 代码评论速度
- 如何编写代码审查评论
- 处理代码审查中的回退(pushback)
文档地址:https://Google.github.io/eng-practices/review/reviewer/
每篇文章中的内容写的都非常的好,非常的全面,包含了为什么这么做,如何做的内容,非常值得大家一读。
看完这两份文档,大家肯定就能了解到 Google 的工程师是如何做 code review 的了。这不,你看,国际性大厂的经验离我们其实也不远嘛。
唯一的缺点就是文档是英文的,需要大家自行想办法去阅读和翻译,不过如果你慢慢去阅读和学习的话,可能不仅仅提高了自己的技术,还提高了自己的英文,何乐而不为呢?
关注公众号:非著名程序员,对话框回复关键字 “1024”,免费领取独立开发者赚钱案例分享,助力程序员实现财务自由。
,