Style guides for Google-originated open-source projects
HTML Python XSLT CSS JavaScript Emacs Lisp Other
Clone or download
tituswinters Merge pull request #389 from manshreck/gh-pages
Add horizontal TOC back into style guide
Latest commit 2b57aa5 Aug 15, 2018
Permalink
Failed to load latest commit information.
cpplint Fix a typo in cpplint Apr 15, 2018
docguide Revert "Project import generated by Copybara." Jan 30, 2018
include Revert "Project import generated by Copybara." Jan 30, 2018
README.md Link to the maintained pyguide.md, not old html. Jun 12, 2018
Rguide.xml Revert "Project import generated by Copybara." Jan 30, 2018
angularjs-google-style.html Revert "Project import generated by Copybara." Jan 30, 2018
cppguide.html Update cppguide.html Aug 14, 2018
cppguide.xml Revert "Project import generated by Copybara." Jan 30, 2018
eclipse-cpp-google-style.xml Revert "Project import generated by Copybara." Jan 30, 2018
eclipse-java-google-style.xml Revert "Project import generated by Copybara." Jan 30, 2018
google-c-style.el Revert "Project import generated by Copybara." Jan 30, 2018
google-r-style.html Revert "Project import generated by Copybara." Jan 30, 2018
google_python_style.vim New file google_python_style.vim. Nov 29, 2010
htmlcssguide.html Revert "Project import generated by Copybara." Jan 30, 2018
htmlcssguide.xml Revert "Project import generated by Copybara." Jan 30, 2018
intellij-java-google-style.xml Revert "Project import generated by Copybara." Jan 30, 2018
javaguide.css Revert "Project import generated by Copybara." Jan 30, 2018
javaguide.html Update Java style guide May 22, 2018
javaguidelink.png Revert "Project import generated by Copybara." Jan 30, 2018
javascriptguide.xml Revert "Project import generated by Copybara." Jan 30, 2018
jsguide.html Revert "Project import generated by Copybara." Jan 30, 2018
jsoncstyleguide.html Revert "Project import generated by Copybara." Jan 30, 2018
jsoncstyleguide.xml Revert "Project import generated by Copybara." Jan 30, 2018
jsoncstyleguide_example_01.png Revert "Project import generated by Copybara." Jan 30, 2018
jsoncstyleguide_example_02.png Revert "Project import generated by Copybara." Jan 30, 2018
lispguide.xml Revert "Project import generated by Copybara." Jan 30, 2018
objcguide.md Revert "Project import generated by Copybara." Jan 30, 2018
objcguide.xml Revert "Project import generated by Copybara." Jan 30, 2018
pyguide.html Link to the maintained pyguide.md, not old html. Jun 12, 2018
pyguide.md Fix rendering for table in pyguide Jun 17, 2018
shell.xml Revert "Project import generated by Copybara." Jan 30, 2018
styleguide.css Revert "Project import generated by Copybara." Jan 30, 2018
styleguide.xsl Revert "Project import generated by Copybara." Jan 30, 2018
vimscriptfull.xml Revert "Project import generated by Copybara." Jan 30, 2018
vimscriptguide.xml Revert "Project import generated by Copybara." Jan 30, 2018
xmlstyle.html Revert "Project import generated by Copybara." Jan 30, 2018

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