每个主要的开源项目都有其自己的风格指南:一套关于如何为该项目编写代码的约定(有时是任意的)。当一个大型代码库中的所有代码都采用一致的风格时,理解起来会容易得多。
“风格”涵盖了很多方面,从“变量名使用驼峰命名法”到“永远不要使用全局变量”再到“永远不要使用异常”。此项目 (google/styleguide) 链接到我们用于 Google 代码的风格指南。如果您正在修改源自 Google 的项目,您可能会被引导到此页面以查看适用于该项目的风格指南。
此项目还包含 google-c-style.el,一个用于 Google 风格的 Emacs 设置文件。
我们曾经托管 cpplint 工具,但我们已停止公开内部更新。 一个开源社区已经 fork 了该项目,因此鼓励用户使用 https://github.com/cpplint/cpplint 代替。
如果您的项目需要您创建新的 XML 文档格式,XML 文档格式风格指南 可能会有所帮助。 除了实际的风格规则外,它还包含关于设计您自己的格式与调整现有格式、XML 实例文档格式以及元素与属性的建议。
此项目中的风格指南在 CC-By 3.0 许可下发布,该许可鼓励您分享这些文档。 有关更多详细信息,请参见 https://creativecommons.org/licenses/by/3.0/。
以下 Google 风格指南不在此项目内
由于项目主要在 VCS 中维护,因此编写良好的提交消息对于项目的长期健康至关重要。 请参考 如何编写 Git 提交消息 作为优秀的资源。 虽然它明确地提到了 Git SCM,但它的原则适用于任何系统,并且许多 Git 约定可以很容易地转换为其他系统。
除了少数例外,这些风格指南是 Google 内部风格指南的副本,旨在帮助开发人员处理 Google 拥有和发起的开源项目。 对风格指南的更改首先在内部风格指南中进行,最终复制到此处找到的版本中。 不接受外部贡献。 Pull Request 会定期关闭,恕不另行通知。
人们可以 使用 GitHub 跟踪器提交 issue。 提出问题、证明基于技术优点的变更或指出明显错误的 issue 可能会得到一些参与,并且理论上可能会导致更改,但我们主要针对 Google 的内部需求进行优化。