You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
sandy 5629dff5f1 PL280 release code 4 years ago
..
cpplint PL280 release code 4 years ago
docguide PL280 release code 4 years ago
include PL280 release code 4 years ago
LICENSE PL280 release code 4 years ago
METADATA PL280 release code 4 years ago
MODULE_LICENSE_BSD PL280 release code 4 years ago
MODULE_LICENSE_CC PL280 release code 4 years ago
NOTICE PL280 release code 4 years ago
OWNERS PL280 release code 4 years ago
README.md PL280 release code 4 years ago
Rguide.xml PL280 release code 4 years ago
angularjs-google-style.html PL280 release code 4 years ago
cppguide.html PL280 release code 4 years ago
cppguide.xml PL280 release code 4 years ago
eclipse-cpp-google-style.xml PL280 release code 4 years ago
eclipse-java-google-style.xml PL280 release code 4 years ago
google-c-style.el PL280 release code 4 years ago
google-r-style.html PL280 release code 4 years ago
google_python_style.vim PL280 release code 4 years ago
htmlcssguide.html PL280 release code 4 years ago
htmlcssguide.xml PL280 release code 4 years ago
intellij-java-google-style.xml PL280 release code 4 years ago
javaguide.css PL280 release code 4 years ago
javaguide.html PL280 release code 4 years ago
javaguidelink.png PL280 release code 4 years ago
javascriptguide.xml PL280 release code 4 years ago
jsguide.html PL280 release code 4 years ago
jsoncstyleguide.html PL280 release code 4 years ago
jsoncstyleguide.xml PL280 release code 4 years ago
jsoncstyleguide_example_01.png PL280 release code 4 years ago
jsoncstyleguide_example_02.png PL280 release code 4 years ago
lispguide.xml PL280 release code 4 years ago
objcguide.md PL280 release code 4 years ago
objcguide.xml PL280 release code 4 years ago
pyguide.html PL280 release code 4 years ago
shell.xml PL280 release code 4 years ago
styleguide.css PL280 release code 4 years ago
styleguide.xsl PL280 release code 4 years ago
vimscriptfull.xml PL280 release code 4 years ago
vimscriptguide.xml PL280 release code 4 years ago
xmlstyle.html PL280 release code 4 years ago

README.md

Google Style Guides

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.

“Style” covers a lot of ground, from “use camelCase for variable names” to “never use global variables” to “never use exceptions.” This project (google/styleguide) links to 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.

This project holds the C++ Style Guide, Objective-C Style Guide, Java Style Guide, Python Style Guide, R Style Guide, Shell Style Guide, HTML/CSS Style Guide, JavaScript Style Guide, AngularJS Style Guide, Common Lisp Style Guide, and Vimscript Style Guide. This project also contains cpplint, a tool to assist with style guide compliance, and google-c-style.el, an Emacs settings file for Google style.

If your project requires that you create a new XML document format, the 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.

The style guides in this project are licensed under the CC-By 3.0 License, which encourages you to share these documents. See https://creativecommons.org/licenses/by/3.0/ for more details.

The following Google style guides live outside of this project: Go Code Review Comments and Effective Dart.

Creative Commons License