8a87a46cc7
Also further improve the documentation and testing around --root. Previously the root=setting in the CFG file was treated identically to passing --root=setting on the command line, which seems undesirable since it depends on were cpplint.cfg was invoked from (for relative paths). Judging on settings such as 'exclude_files' it seems within the spirit to make the settings 'current working directory' contextual to the same directory that CPPLINT.cfg is in. This also makes execution consistent (picking up the "correct" settings) regardless of the CWD when executing cpplint.py. Example: echo 'root=..' >> /a/b/c/CPPLINT.cfg cd / cpplint.py /a/b/c/source_file.h # expects header guard of C_SOURCE_FILE_H_ However the old behavior would use '/../' = '/' and incorrectly think the root was 'A_B_C_SOURCE_FILE_H_'. |
||
|---|---|---|
| cpplint | ||
| docguide | ||
| include | ||
| angularjs-google-style.html | ||
| cppguide.html | ||
| cppguide.xml | ||
| eclipse-cpp-google-style.xml | ||
| eclipse-java-google-style.xml | ||
| google_python_style.vim | ||
| google-c-style.el | ||
| google-r-style.html | ||
| htmlcssguide.html | ||
| htmlcssguide.xml | ||
| intellij-java-google-style.xml | ||
| javaguide.css | ||
| javaguide.html | ||
| javaguidelink.png | ||
| javascriptguide.xml | ||
| jsguide.html | ||
| jsoncstyleguide_example_01.png | ||
| jsoncstyleguide_example_02.png | ||
| jsoncstyleguide.html | ||
| jsoncstyleguide.xml | ||
| lispguide.xml | ||
| objcguide.md | ||
| objcguide.xml | ||
| pyguide.html | ||
| README.md | ||
| Rguide.xml | ||
| shell.xml | ||
| styleguide.css | ||
| styleguide.xsl | ||
| vimscriptfull.xml | ||
| vimscriptguide.xml | ||
| xmlstyle.html | ||
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.
