Style guides for Google-originated open-source projects
Go to file
Alexey Serbin 375f6623a0 [cpplint] detection of broken std::regex in libstdc++
Added detection of broken std::regex and friends in older
versions of libstdc++ (< 4.9) into the cpplint tool.  For details,
see [1].

The motivation for this change is the fact that some projects still
need to be compiled and linked against older libstdc++ at still
supported Linux distros such as RHEL/CentOS 7, Ubuntu 14.04 and SLES 12,
but using C++11 std::regex functionality could lead to unexpected crash
if the code is compiled with C++11-compatible compiler and linked aginst
libstdc++ of versions prior to 4.9.

References:
  [1] https://gcc.gnu.org/onlinedocs/gcc-4.8.2/libstdc++/manual/manual/status.html#status.iso.2011
      section 28 'Regular Expressions'
2019-02-03 21:02:08 -08:00
cpplint [cpplint] detection of broken std::regex in libstdc++ 2019-02-03 21:02:08 -08:00
docguide Revert "Project import generated by Copybara." 2018-01-30 12:36:50 -05:00
include Revert "Project import generated by Copybara." 2018-01-30 12:36:50 -05:00
angularjs-google-style.html Revert "Project import generated by Copybara." 2018-01-30 12:36:50 -05:00
cppguide.html Update cppguide.html 2018-08-14 16:12:59 -04:00
cppguide.xml Revert "Project import generated by Copybara." 2018-01-30 12:36:50 -05:00
eclipse-cpp-google-style.xml Revert "Project import generated by Copybara." 2018-01-30 12:36:50 -05:00
eclipse-java-google-style.xml Revert "Project import generated by Copybara." 2018-01-30 12:36:50 -05:00
google_python_style.vim New file google_python_style.vim. 2010-11-29 20:32:06 +00:00
google-c-style.el Revert "Project import generated by Copybara." 2018-01-30 12:36:50 -05:00
google-r-style.html Revert "Project import generated by Copybara." 2018-01-30 12:36:50 -05:00
htmlcssguide.html Revert "Project import generated by Copybara." 2018-01-30 12:36:50 -05:00
htmlcssguide.xml Revert "Project import generated by Copybara." 2018-01-30 12:36:50 -05:00
intellij-java-google-style.xml Revert "Project import generated by Copybara." 2018-01-30 12:36:50 -05:00
javaguide.css Revert "Project import generated by Copybara." 2018-01-30 12:36:50 -05:00
javaguide.html Update Java style guide 2018-05-22 16:44:47 -07:00
javaguidelink.png Revert "Project import generated by Copybara." 2018-01-30 12:36:50 -05:00
javascriptguide.xml Revert "Project import generated by Copybara." 2018-01-30 12:36:50 -05:00
jsguide.html Revert "Project import generated by Copybara." 2018-01-30 12:36:50 -05:00
jsoncstyleguide_example_01.png Revert "Project import generated by Copybara." 2018-01-30 12:36:50 -05:00
jsoncstyleguide_example_02.png Revert "Project import generated by Copybara." 2018-01-30 12:36:50 -05:00
jsoncstyleguide.html Revert "Project import generated by Copybara." 2018-01-30 12:36:50 -05:00
jsoncstyleguide.xml Revert "Project import generated by Copybara." 2018-01-30 12:36:50 -05:00
lispguide.xml Revert "Project import generated by Copybara." 2018-01-30 12:36:50 -05:00
objcguide.md [objc] Update the Objective-C style guide 📜 2018-08-17 18:47:57 -07:00
objcguide.xml Revert "Project import generated by Copybara." 2018-01-30 12:36:50 -05:00
pyguide.md Project import generated by Copybara. 2018-12-05 14:43:27 -08:00
README.md Update pyguide link README 2018-09-11 23:36:07 +08:00
Rguide.xml Revert "Project import generated by Copybara." 2018-01-30 12:36:50 -05:00
shell.xml Revert "Project import generated by Copybara." 2018-01-30 12:36:50 -05:00
styleguide.css Revert "Project import generated by Copybara." 2018-01-30 12:36:50 -05:00
styleguide.xsl Revert "Project import generated by Copybara." 2018-01-30 12:36:50 -05:00
vimscriptfull.xml Revert "Project import generated by Copybara." 2018-01-30 12:36:50 -05:00
vimscriptguide.xml Revert "Project import generated by Copybara." 2018-01-30 12:36:50 -05:00
xmlstyle.html Revert "Project import generated by Copybara." 2018-01-30 12:36:50 -05:00

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