谷歌风格指南¶
来源:styleguide
每个主要的开源项目都有自己的风格指南:一套关于如何为该项目编写代码的惯例(有时是任意的)。风格一致时,理解一个大型代码库要容易得多。
“风格” 涵盖了很多方面,从 “对变量名使用 camelCase” 到 “绝不使用全局变量” 再到 “绝不使用异常”。项目 google/styleguide 链接到谷歌的代码风格指南。如果你正在修改一个 的项目,你可能会被引导到这个页面,来查看适用于该项目的风格指南。
项目持有 C++ 风格指南、C# 风格指南、Swift 风格指南, Objective-C 风格指南、Java 风格指南, Python 风格指南、R 风格指南、Shell 风格指南、HTML/CSS 风格指南、JavaScript 风格指南、TypeScript 风格指南、AngularJS 风格指南、Common Lisp Style Guide 和 Vimscript Style Guide。项目还包含 cpplint (一个帮助遵守风格指南的工具)和 google-c-style.el(一个用于谷歌风格的 Emacs 设置文件)。
如果你的项目要求你创建一个新的 XML 文档格式,XML 文档格式风格指南 可能会有帮助。除了实际的风格规则外,它还包含了关于设计你自己的与适应现有格式的建议,关于 XML 实例文件格式的建议,以及关于元素与属性的建议。
本项目中的风格指南是在 CC-By 3.0 许可下授权的。它鼓励你分享这些文件。更多细节请参见 https://creativecommons.org/licenses/by/3.0/。
以下的谷歌风格指南是在本项目之外的:Go Code Review Comments 和 Effective Dart。
贡献
除了少数例外,这些风格指南是谷歌内部风格指南的副本,以协助开发人员在谷歌拥有的和原创的开源项目中工作。风格指南的修改首先在内部风格指南中进行,最终复制到这里的版本中。不接受外部贡献。
拉取请求经常被关闭,没有评论。提出问题、证明技术上的变化或指出明显的错误的问题可能会得到一些参与,并在理论上可能会导致变化,但我们主要是为谷歌的内部需求进行优化。