文章目录
- Google Style Guides:给代码定规矩这件事,Google 做到了极致
- 1、 这个项目是干嘛的
- 2、 覆盖哪些语言
- 3、 为什么要用它
- 4、 怎么用
- 5、 适合谁
Google Style Guides:给代码定规矩这件事,Google 做到了极致
google/styleguide 在 GitHub 上已经拿到 39,389 Star 了。
Google 把自家内部用的编码风格指南全部开源了,覆盖十几种编程语言。每个语言一套规范,从变量命名到异常处理,事无巨细。
1、 这个项目是干嘛的
就一件事:告诉你写代码该长什么样。
每个大型开源项目都有自己的风格指南。风格统一的代码库,读起来省心,维护起来也省事。Google 深谙此道,所以他们内部的每种主力语言都有一份详细的规范文档。
这个仓库把这些指南集中到了一起。
2、 覆盖哪些语言
打开仓库,能看到一长串语言列表:C++、Java、Python、Go、JavaScript、TypeScript、Swift、Rust、Shell、AngularJS、HTML/CSS、Objective-C、C#、JSON、Markdown,甚至还有 Common Lisp 和 Vim script。
每份指南都是独立的文档,内容来自 Google 内部实际使用的规范。不是社区爱好者写的建议,是真正在大规模工程里跑了几十年的经验总结。
3、 为什么要用它
自己团队从零定一套代码规范,成本很高。哪些规则该加,哪些规则太死板,需要反复试错。
Google 帮你趟过这条路了。他们的指南不是拍脑袋写的,每一条规则背后都有工程上的理由。比如 C++ 指南里对异常处理的规定,Java 指南里对类命名的约束,Go 指南里对错误处理的建议,都是从实际项目中提炼出来的。
直接拿来用,或者在此基础上裁剪,比从头写省太多时间。
4、 怎么用
不需要安装任何东西。每份指南都是独立的网页或文档,打开就能看。
想在编辑器里实时检查代码风格,可以用配套的 lint 工具。比如 Python 有 pycodestyle,JavaScript 有 ESLint 的 Google 配置,C++ 有 cpplint(社区维护的开源版本)。
把这些工具集成到 CI 流水线里,代码风格检查就能自动化。
5、 适合谁
- 刚组建技术团队,需要快速建立编码规范的公司
- 开源项目维护者,想参考成熟规范来制定自己的指南
- 个人开发者,想提升代码质量,养成好的编码习惯
维护者,想参考成熟规范来制定自己的指南
- 个人开发者,想提升代码质量,养成好的编码习惯