https://github.com/johnantoni/google-styleguide
mirror of Style guides for Google-oriented open-source projects
https://github.com/johnantoni/google-styleguide
Last synced: 22 days ago
JSON representation
mirror of Style guides for Google-oriented open-source projects
- Host: GitHub
- URL: https://github.com/johnantoni/google-styleguide
- Owner: johnantoni
- Created: 2010-02-03T12:49:54.000Z (over 16 years ago)
- Default Branch: master
- Last Pushed: 2010-02-03T12:54:12.000Z (over 16 years ago)
- Last Synced: 2025-06-23T09:06:01.510Z (about 1 year ago)
- Language: Python
- Homepage: http://code.google.com/p/google-styleguide/
- Size: 234 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README
Awesome Lists containing this project
README
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 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.
Our C++ Style Guide, Objective-C Style Guide, and Python 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.
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.
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.