2015-05-21 06:29:26 +08:00
|
|
|
Google Style Guides
|
|
|
|
|
===================
|
|
|
|
|
|
2016-02-16 06:37:51 +08:00
|
|
|
Every major open-source project has its own style guide: a set of conventions
|
|
|
|
|
(sometimes arbitrary) about how to write code for that project. It is much
|
|
|
|
|
easier to understand a large codebase when all the code in it is in a
|
|
|
|
|
consistent style.
|
2015-05-21 03:28:50 +08:00
|
|
|
|
2016-02-16 06:37:51 +08:00
|
|
|
“Style” covers a lot of ground, from “use camelCase for variable names” to
|
|
|
|
|
“never use global variables” to “never use exceptions.” This project holds the
|
|
|
|
|
style guidelines we use for Google code. If you are modifying a project that
|
|
|
|
|
originated at Google, you may be pointed to this page to see the style guides
|
|
|
|
|
that apply to that project.
|
2015-05-21 03:28:50 +08:00
|
|
|
|
2016-02-16 06:37:51 +08:00
|
|
|
Our [C++ Style Guide][cpp], [Objective-C Style Guide][objc], [Java Style
|
|
|
|
|
Guide][java], [Python Style Guide][py], [R Style Guide][r], [Shell Style
|
|
|
|
|
Guide][sh], [HTML/CSS Style Guide][htmlcss], [JavaScript Style Guide][js],
|
|
|
|
|
[AngularJS Style Guide][angular], [Common Lisp Style Guide][cl], and [Vimscript
|
|
|
|
|
Style Guide][vim] are now available. We have also released [cpplint][cpplint],
|
|
|
|
|
a tool to assist with style guide compliance, and [google-c-style.el][emacs],
|
|
|
|
|
an Emacs settings file for Google style.
|
2015-05-21 03:28:50 +08:00
|
|
|
|
2016-02-16 06:37:51 +08:00
|
|
|
If your project requires that you create a new XML document format, our [XML
|
|
|
|
|
Document Format Style Guide][xml] may be helpful. In addition to actual style
|
|
|
|
|
rules, it also contains advice on designing your own vs. adapting an existing
|
|
|
|
|
format, on XML instance document formatting, and on elements vs. attributes.
|
2015-05-21 03:28:50 +08:00
|
|
|
|
2016-02-16 06:37:51 +08:00
|
|
|
These style guides are licensed under the CC-By 3.0 License, which encourages
|
2016-04-01 16:41:34 +08:00
|
|
|
you to share these documents. See [https://creativecommons.org/licenses/by/3.0/](https://creativecommons.org/licenses/by/3.0/)
|
2016-02-16 06:37:51 +08:00
|
|
|
for more details.
|
|
|
|
|
|
2016-04-01 16:41:34 +08:00
|
|
|
<a rel="license" href="https://creativecommons.org/licenses/by/3.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by/3.0/88x31.png" /></a>
|
2015-05-21 06:29:26 +08:00
|
|
|
|
2016-04-01 16:41:34 +08:00
|
|
|
[cpp]: https://google.github.io/styleguide/cppguide.html
|
|
|
|
|
[objc]: https://google.github.io/styleguide/objcguide.xml
|
|
|
|
|
[java]: https://google.github.io/styleguide/javaguide.html
|
|
|
|
|
[py]: https://google.github.io/styleguide/pyguide.html
|
|
|
|
|
[r]: https://google.github.io/styleguide/Rguide.xml
|
|
|
|
|
[sh]: https://google.github.io/styleguide/shell.xml
|
|
|
|
|
[htmlcss]: https://google.github.io/styleguide/htmlcssguide.xml
|
2016-11-03 08:17:28 +08:00
|
|
|
[js]: https://google.github.io/styleguide/jsguide.html
|
2016-04-01 16:41:34 +08:00
|
|
|
[angular]: https://google.github.io/styleguide/angularjs-google-style.html
|
|
|
|
|
[cl]: https://google.github.io/styleguide/lispguide.xml
|
|
|
|
|
[vim]: https://google.github.io/styleguide/vimscriptguide.xml
|
2015-05-21 06:29:26 +08:00
|
|
|
[cpplint]: https://github.com/google/styleguide/tree/gh-pages/cpplint
|
|
|
|
|
[emacs]: https://raw.githubusercontent.com/google/styleguide/gh-pages/google-c-style.el
|
2016-04-01 16:41:34 +08:00
|
|
|
[xml]: https://google.github.io/styleguide/xmlstyle.html
|
