Google 风格指南
每个主要的开源项目都有自己的风格指南:一套关于如何为该项目编写代码的约定(有时是任意的)。当一个大型代码库中的所有代码都采用一致的风格时,理解起来会容易得多。
"风格"涵盖了很多方面,从"使用驼峰命名法命名变量"到"永远不要使用全局变量"再到"永远不要使用异常"。本项目(google/styleguide)链接到我们用于 Google 代码的风格指南。如果你正在修改一个源自 Google 的项目,你可能会被指引到此页面,以查看适用于该项目的风格指南。
- AngularJS 风格指南
- Common Lisp 风格指南
- C++ 风格指南
- C# 风格指南
- Go 风格指南
- HTML/CSS 风格指南
- JavaScript 风格指南
- Java 风格指南
- JSON 风格指南
- Markdown 风格指南
- Objective-C 风格指南
- Python 风格指南
- R 风格指南
- Shell 风格指南
- Swift 风格指南
- TypeScript 风格指南
- Vim script 风格指南
本项目还包含 cpplint,一个辅助风格指南遵循的工具,以及 google-c-style.el,一个用于 Google 风格的 Emacs 设置文件。
如果你的项目需要创建一个新的 XML 文档格式,XML 文档格式风格指南可能会有所帮助。除了实际的风格规则外,它还包含了关于设计自己的格式与采用现有格式的建议,XML 实例文档格式化,以及元素与属性的使用。
本项目中的风格指南采用 CC-By 3.0 许可证,该许可证鼓励你分享这些文档。更多详情请参见 https://creativecommons.org/licenses/by/3.0/。
以下 Google 风格指南位于本项目之外:
贡献
除少数例外,这些风格指南是 Google 内部风格指南的副本,用于协助开发者处理 Google 拥有和发起的开源项目。风格指南的变更首先会在内部风格指南中进行,然后最终复制到这里的版本中。**不接受外部贡献。**拉取请求通常会被无理由关闭。
人们可以使用 GitHub 问题跟踪器 提交问题。提出问题、基于技术理由证明变更合理或指出明显错误的问题可能会得到一些回应,理论上可能会导致变更,但我们主要是针对 Google 内部需求进行优化。