|
| 1 | +Google Style Guides |
| 2 | +=================== |
| 3 | + |
1 | 4 | 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. |
2 | 5 |
|
3 | 6 | “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. |
4 | 7 |
|
5 | | -Our C++ Style Guide, Objective-C Style Guide, Java Style Guide, Python Style Guide, Shell Style Guide, HTML/CSS Style Guide, JavaScript Style Guide, AngularJS Style Guide, Common Lisp Style Guide, and Vimscript Style Guide are now available. We have also released cpplint, a tool to assist with style guide compliance, and google-c-style.el, an Emacs settings file for Google style. |
| 8 | +Our [C++ Style Guide][cpp], [Objective-C Style Guide][objc], [Java Style Guide][java], [Python Style Guide][py], [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. |
6 | 9 |
|
7 | | -If your project requires that you create a new XML document format, our XML Document Format Style Guide 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. |
| 10 | +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. |
8 | 11 |
|
9 | 12 | These style guides are licensed under the CC-By 3.0 License, which encourages you to share these documents. See http://creativecommons.org/licenses/by/3.0/ for more details. |
| 13 | + |
| 14 | +[cpp]: http://google.github.io/styleguide/cppguide.html |
| 15 | +[objc]: http://google.github.io/styleguide/objcguide.xml |
| 16 | +[java]: http://google.github.io/styleguide/javaguide.html |
| 17 | +[py]: http://google.github.io/styleguide/pyguide.html |
| 18 | +[sh]: http://google.github.io/styleguide/shell.xml |
| 19 | +[htmlcss]: http://google.github.io/styleguide/htmlcssguide.xml |
| 20 | +[js]: http://google.github.io/styleguide/javascriptguide.xml |
| 21 | +[angular]: http://google.github.io/styleguide/angularjs-google-style.html |
| 22 | +[cl]: http://google.github.io/styleguide/lispguide.xml |
| 23 | +[vim]: http://google.github.io/styleguide/vimscriptguide.xml |
| 24 | +[cpplint]: https://github.com/google/styleguide/tree/gh-pages/cpplint |
| 25 | +[emacs]: https://raw.githubusercontent.com/google/styleguide/gh-pages/google-c-style.el |
| 26 | +[xml]: http://google.github.io/styleguide/xmlstyle.html |
0 commit comments