Google 对外开放的这份工程实践文档,我爱了...

公众号关注 “GitCube”

设为 “星标”,发现更多计算机优质资源!

大家好,我是小 G。

今天跟大家分享一份来自 Google 团队的工程实践文档:Google's Engineering Practices documentation。

这份文档积累自 Google 团队长期以来的内部项目最佳实践,其目的在于帮助开发者更好的做好代码审查工作,通过 Code Review 来提升并优化当前项目的代码质量,也便于后续开发人员的维护与管理。

其实,代码审查这件事,长期以来在国内一直没有得到其应有的重视,不少开发者或项目经理,都觉得没有必要在代码审查这件事情上投入过多经理,认为摆在他们面前有更为重要与紧急的事情要去处理。

一般对这件事情的最终处理方式,就是一直拖着。拖到某一天,突然发现项目体积过大,新增功能成本过高,代码过分冗余,可维护性越来越差,这时才不得不狠下心来,对项目代码进行重构,每当项目经过这么一番折腾,伤筋动骨那都是在所难免的。

既然这样,为何不从一开始就在团队内部设立好代码审查机制,定期抽出时间来对项目代码进行全方位的盘查呢?

如果你跟小 G 想的一样,那 Google 的这份代码审查指南对你来说,再合适不过了。

这份指南主要拆分为两大块:

  • 代码审查者指南

  • 代码开发者指南

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

在 Google 工程师看来,代码审查者应该对项目的设计、功能、复杂度、测试、命名、注释、风格、文档等几大要素进行重点关注。

如果一步步做好这几件事,指南里面均有提及,这里便不多做赘述了。

目前 Google 的这份文档已正式开源到了 GitHub 上,并且还基于 GitHub Pages 构建了文档的静态站点。

此外,英文不太好的同学也不用过于担心,国内有开发者已将这份指南翻译成了中文,下面是该项目的完整链接,感兴趣的同学可以看一下。

  • 中文版:https://jimmysong.io/eng-practices/

  • 英文版:https://google.github.io/eng-practices/

  • GitHub 地址:https://github.com/google/eng-practices

以上,便是今天的分享,希望大家喜欢,觉得内容不错的,欢迎点击「在看」支持,谢谢各位。

---

另外,由 GitHubDaily 原班人马打造的公众号:GitCube,现已正式上线!
接下来我们将会在该公众号上,为大家分享优质的计算机学习资源与开发者工具,坚持每天一篇原创文章的输出,感兴趣的小伙伴可以关注一下哈!

展开阅读全文

没有更多推荐了,返回首页

©️2019 CSDN 皮肤主题: 大白 设计师: CSDN官方博客
应支付0元
点击重新获取
扫码支付

支付成功即可阅读