Google Style Guides:给代码定规矩这件事,Google 做到了极致
文章目录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 有 pycodestyleJavaScript 有 ESLint 的 Google 配置C 有 cpplint社区维护的开源版本。把这些工具集成到 CI 流水线里代码风格检查就能自动化。5、 适合谁刚组建技术团队需要快速建立编码规范的公司开源项目维护者想参考成熟规范来制定自己的指南个人开发者想提升代码质量养成好的编码习惯维护者想参考成熟规范来制定自己的指南个人开发者想提升代码质量养成好的编码习惯