From 5748e09d813cb8fd67d3bc7c2cfffdaf86f6d2e0 Mon Sep 17 00:00:00 2001 From: Thibault Kruse Date: Mon, 26 Oct 2015 14:41:27 +0100 Subject: [PATCH] Guides as Asciidoc files --- Rguide.asciidoc | 340 ++ Rguide.xml | 447 --- angularjs-google-style.asciidoc | 328 ++ angularjs-google-style.html | 395 -- cppguide.asciidoc | 2861 +++++++++++++++ cppguide.html | 6117 ------------------------------- cppguide.xml | 18 - google-r-style.html | 18 - htmlcssguide.asciidoc | 937 +++++ htmlcssguide.xml | 1117 ------ javaguide.asciidoc | 847 +++++ javaguide.css | 515 --- javaguide.html | 793 ---- javaguidelink.png | Bin 189 -> 0 bytes javascriptguide.asciidoc | 2733 ++++++++++++++ javascriptguide.xml | 3627 ------------------ jsoncstyleguide.asciidoc | 1478 ++++++++ jsoncstyleguide.html | 18 - jsoncstyleguide.xml | 1187 ------ lispguide.asciidoc | 1653 +++++++++ lispguide.xml | 3887 -------------------- objcguide.asciidoc | 1286 +++++++ objcguide.xml | 1884 ---------- pyguide.asciidoc | 1250 +++++++ pyguide.html | 2311 ------------ shell.asciidoc | 889 +++++ shell.xml | 1152 ------ styleguide.css | 147 - styleguide.xsl | 924 ----- vimscriptfull.asciidoc | 864 +++++ vimscriptfull.xml | 1534 -------- vimscriptguide.asciidoc | 333 ++ vimscriptguide.xml | 412 --- xmlstyle.asciidoc | 174 + xmlstyle.html | 681 ---- 35 files changed, 15973 insertions(+), 27184 deletions(-) create mode 100644 Rguide.asciidoc delete mode 100644 Rguide.xml create mode 100644 angularjs-google-style.asciidoc delete mode 100644 angularjs-google-style.html create mode 100644 cppguide.asciidoc delete mode 100644 cppguide.html delete mode 100644 cppguide.xml delete mode 100644 google-r-style.html create mode 100644 htmlcssguide.asciidoc delete mode 100644 htmlcssguide.xml create mode 100644 javaguide.asciidoc delete mode 100644 javaguide.css delete mode 100644 javaguide.html delete mode 100644 javaguidelink.png create mode 100644 javascriptguide.asciidoc delete mode 100644 javascriptguide.xml create mode 100644 jsoncstyleguide.asciidoc delete mode 100644 jsoncstyleguide.html delete mode 100644 jsoncstyleguide.xml create mode 100644 lispguide.asciidoc delete mode 100644 lispguide.xml create mode 100644 objcguide.asciidoc delete mode 100644 objcguide.xml create mode 100644 pyguide.asciidoc delete mode 100644 pyguide.html create mode 100644 shell.asciidoc delete mode 100644 shell.xml delete mode 100644 styleguide.css delete mode 100644 styleguide.xsl create mode 100644 vimscriptfull.asciidoc delete mode 100644 vimscriptfull.xml create mode 100644 vimscriptguide.asciidoc delete mode 100644 vimscriptguide.xml create mode 100644 xmlstyle.asciidoc delete mode 100644 xmlstyle.html diff --git a/Rguide.asciidoc b/Rguide.asciidoc new file mode 100644 index 0000000..0597089 --- /dev/null +++ b/Rguide.asciidoc @@ -0,0 +1,340 @@ += Google's R Style Guide +:sectlinks: + + +R is a high-level programming language used primarily for statistical computing and graphics. The goal of the R Programming Style Guide is to make our R code easier to read, share, and verify. The rules below were designed in collaboration with the entire R user community at Google. + +== Summary: R Style Rules + +1. link:#filenames[File Names]: end in `.R` +2. link:#identifiers[Identifiers]: `variable.name` (or `variableName`), `FunctionName`, `kConstantName` +3. link:#linelength[Line Length]: maximum 80 characters +4. link:#indentation[Indentation]: two spaces, no tabs +5. link:#spacing[Spacing] +6. link:#curlybraces[Curly Braces]: first on same line, last on own line +7. link:#else[else]: Surround else with braces +8. link:#assignment[Assignment]: use `<-`, not `=` +9. link:#semicolons[Semicolons]: don't use them +10. link:#generallayout[General Layout and Ordering] +11. link:#comments[Commenting Guidelines]: all comments begin with `#` followed by a space; inline comments need two spaces before the `#` +12. link:#functiondefinition[Function Definitions and Calls] +13. link:#functiondocumentation[Function Documentation] +14. link:#examplefunction[Example Function] +15. link:#todo[TODO Style]: `TODO(username)` + +== Summary: R Language Rules + +1. link:#attach[`attach`]: avoid using it +2. link:#functionlanguage[Functions]: errors should be raised using `stop()` +3. link:#object[Objects and Methods]: avoid S4 objects and methods when possible; never mix S3 and S4 + +=== Notation and Naming + +[[filenames]] +==== File Names + +File names should end in `.R` and, of course, be meaningful. + + GOOD: `predict_ad_revenue.R` + + BAD: `foo.R` + +[[identifiers]] +==== Identifiers + +Don't use underscores ( `_` ) or hyphens ( `-` ) in identifiers. Identifiers should be named according to the following conventions. The preferred form for variable names is all lower case letters and words separated with dots (`variable.name`), but `variableName` is also accepted; function names have initial capital letters and no dots (`FunctionName`); constants are named like functions but with an initial `k`. + +* `variable.name` is preferred, `variableName` is accepted + + GOOD: `avg.clicks` + + OK: `avgClicks` + + BAD: `avg_Clicks` +* `FunctionName ` + + GOOD: `CalculateAvgClicks` + + BAD: `calculate_avg_clicks `, `calculateAvgClicks` + + Make function names verbs. + +_Exception: When creating a classed object, the function name (constructor) and class should match (e.g., lm)._ +* `kConstantName ` + +=== Syntax + +[[linelength]] +==== Line Length + +The maximum line length is 80 characters. + +[[indentation]] +==== Indentation + +When indenting your code, use two spaces. Never use tabs or mix tabs and spaces. + +_Exception: When a line break occurs inside parentheses, align the wrapped line with the first character inside the parenthesis._ + +[[spacing]] +==== Spacing + +Place spaces around all binary operators (`=`, `+`, `-`, `<-`, etc.). + + _Exception: Spaces around `=`'s are optional when passing parameters in a function call._ + +Do not place a space before a comma, but always place one after a comma. + + + + GOOD: + +----------------------------------------------------------- +tab.prior <- table(df[df$days.from.opt < 0, "campaign.id"]) +total <- sum(x[, 1]) +total <- sum(x[1, ]) +----------------------------------------------------------- + +BAD: + +------------------------------------------------------------------------------------------- +tab.prior <- table(df[df$days.from.opt<0, "campaign.id"]) # Needs spaces around '<' +tab.prior <- table(df[df$days.from.opt < 0,"campaign.id"]) # Needs a space after the comma +tab.prior<- table(df[df$days.from.opt < 0, "campaign.id"]) # Needs a space before <- +tab.prior<-table(df[df$days.from.opt < 0, "campaign.id"]) # Needs spaces around <- +total <- sum(x[,1]) # Needs a space after the comma +total <- sum(x[ ,1]) # Needs a space after the comma, not before +------------------------------------------------------------------------------------------- + +Place a space before left parenthesis, except in a function call. + +GOOD: + +`if (debug)` + +BAD: + +`if(debug)` + +Extra spacing (i.e., more than one space in a row) is okay if it improves alignment of equals signs or arrows (`<-`). + +----------------------------------------------------------------- +plot(x = x.coord, + y = data.mat[, MakeColName(metric, ptiles[1], "roiOpt")], + ylim = ylim, + xlab = "dates", + ylab = metric, + main = (paste(metric, " for 3 samples ", sep = ""))) +----------------------------------------------------------------- + +Do not place spaces around code in parentheses or square brackets. + + _Exception: Always place a space after a comma._ + +GOOD: + +---------- +if (debug) +x[1, ] +---------- + +BAD: + +--------------------------------------- +if ( debug ) # No spaces around debug +x[1,] # Needs a space after the comma +--------------------------------------- + +[[curlybraces]] +==== Curly Braces + +An opening curly brace should never go on its own line; a closing curly brace should always go on its own line. You may omit curly braces when a block consists of a single statement; however, you must _consistently_ either use or not use curly braces for single statement blocks. + +-------------------- +if (is.null(ylim)) { + ylim <- c(0, 0.06) +} +-------------------- + +xor (but not both) + +-------------------- +if (is.null(ylim)) + ylim <- c(0, 0.06) +-------------------- + +Always begin the body of a block on a new line. + +BAD: + +` if (is.null(ylim)) ylim <- c(0, 0.06)` + +` if (is.null(ylim)) {ylim <- c(0, 0.06)} ` + +[[else]] +==== Surround else with braces + +An `else` statement should always be surrounded on the same line by curly braces. + +------------------- +if (condition) { + one or more lines +} else { + one or more lines +} +------------------- + +BAD: + + +------------------- +if (condition) { + one or more lines +} +else { + one or more lines +} +------------------- + +BAD: + + +-------------- +if (condition) + one line +else + one line +-------------- + +[[assignment]] +==== Assignment + +Use `<-`, not `=`, for assignment. + +GOOD: + +` x <- 5 ` + +BAD: + +` x = 5` + +[[semicolons]] +==== Semicolons + +Do not terminate your lines with semicolons or use semicolons to put more than one command on the same line. (Semicolons are not necessary, and are omitted for consistency with other Google style guides.) + +=== Organization + +[[generallayout]] +==== General Layout and Ordering + +If everyone uses the same general ordering, we'll be able to read and understand each other's scripts faster and more easily. + +1. Copyright statement comment +2. Author comment +3. File description comment, including purpose of program, inputs, and outputs +4. `source()` and `library()` statements +5. Function definitions +6. Executed statements, if applicable (e.g., ` print`, `plot`) + +Unit tests should go in a separate file named `originalfilename_test.R`. + +[[comments]] +==== Commenting Guidelines + +Comment your code. Entire commented lines should begin with `#` and one space. + +Short comments can be placed after code preceded by two spaces, `#`, and then one space. + +----------------------------------------------------------------- +# Create histogram of frequency of campaigns by pct budget spent. +hist(df$pct.spent, + breaks = "scott", # method for choosing number of buckets + main = "Histogram: fraction budget spent by campaignid", + xlab = "Fraction of budget spent", + ylab = "Frequency (count of campaignids)") +----------------------------------------------------------------- + +[[functiondefinition]] +==== Function Definitions and Calls + +Function definitions should first list arguments without default values, followed by those with default values. + +In both function definitions and function calls, multiple arguments per line are allowed; line breaks are only allowed between assignments. + +GOOD: + +------------------------------------------------- +PredictCTR <- function(query, property, num.days, + show.plot = TRUE) +------------------------------------------------- + +BAD: + +------------------------------------------------------------- +PredictCTR <- function(query, property, num.days, show.plot = + TRUE) +------------------------------------------------------------- + +Ideally, unit tests should serve as sample function calls (for shared library routines). + +[[functiondocumentation]] +==== Function Documentation + +Functions should contain a comments section immediately below the function definition line. These comments should consist of a one-sentence description of the function; a list of the function's arguments, denoted by `Args:`, with a description of each (including the data type); and a description of the return value, denoted by `Returns:`. The comments should be descriptive enough that a caller can use the function without reading any of the function's code. + +[[examplefunction]] +==== Example Function + +------------------------------------------------------------------------------- +CalculateSampleCovariance <- function(x, y, verbose = TRUE) { + # Computes the sample covariance between two vectors. + # + # Args: + # x: One of two vectors whose sample covariance is to be calculated. + # y: The other vector. x and y must have the same length, greater than one, + # with no missing values. + # verbose: If TRUE, prints sample covariance; if not, not. Default is TRUE. + # + # Returns: + # The sample covariance between x and y. + n <- length(x) + # Error handling + if (n <= 1 || n != length(y)) { + stop("Arguments x and y have different lengths: ", + length(x), " and ", length(y), ".") + } + if (TRUE %in% is.na(x) || TRUE %in% is.na(y)) { + stop(" Arguments x and y must not have missing values.") + } + covariance <- var(x, y) + if (verbose) + cat("Covariance = ", round(covariance, 4), ".\n", sep = "") + return(covariance) +} +------------------------------------------------------------------------------- + +[[todo]] +==== TODO Style + +Use a consistent style for TODOs throughout your code. + +`TODO(username): Explicit description of action to be taken` + +=== Language + +[[attach]] +==== Attach + +The possibilities for creating errors when using `attach` are numerous. Avoid it. + +[[functionlanguage]] +==== Functions + +Errors should be raised using `stop()`. + +[[object]] +==== Objects and Methods + +The S language has two object systems, S3 and S4, both of which are available in R. S3 methods are more interactive and flexible, whereas S4 methods are more formal and rigorous. (For an illustration of the two systems, see Thomas Lumley's "Programmer's Niche: A Simple Class, in S3 and S4" in R News 4/1, 2004, pgs. 33 - 36: http://cran.r-project.org/doc/Rnews/Rnews_2004-1.pdf.) + +Use S3 objects and methods unless there is a strong reason to use S4 objects or methods. A primary justification for an S4 object would be to use objects directly in C++ code. A primary justification for an S4 generic/method would be to dispatch on two arguments. + +Avoid mixing S3 and S4: S4 methods ignore S3 inheritance and vice-versa. + +=== Exceptions + +The coding conventions described above should be followed, unless there is good reason to do otherwise. Exceptions include legacy code and modifying third-party code. + +=== Parting Words + +Use common sense and BE CONSISTENT. + +If you are editing code, take a few minutes to look at the code around you and determine its style. If others use spaces around their `if ` clauses, you should, too. If their comments have little boxes of stars around them, make your comments have little boxes of stars around them, too. + +The point of having style guidelines is to have a common vocabulary of coding so people can concentrate on _what_ you are saying, rather than on _how_ you are saying it. We present global style rules here so people know the vocabulary. But local style is also important. If code you add to a file looks drastically different from the existing code around it, the discontinuity will throw readers out of their rhythm when they go to read it. Try to avoid this. + +OK, enough writing about writing code; the code itself is much more interesting. Have fun! + +=== References + +http://www.maths.lth.se/help/R/RCC/ - R Coding Conventions + +http://ess.r-project.org/ - For emacs users. This runs R in your emacs and has an emacs mode. diff --git a/Rguide.xml b/Rguide.xml deleted file mode 100644 index add76d3..0000000 --- a/Rguide.xml +++ /dev/null @@ -1,447 +0,0 @@ - - - - - - Google's R Style Guide - - - - -

Google's R Style Guide

- -

- R is a high-level programming language used primarily for - statistical computing and graphics. The goal of the R - Programming Style Guide is to make our R code easier to read, - share, and verify. The rules below were designed in - collaboration with the entire R user community at Google. - -

- - - - - - -

Summary: R Style Rules

- -
    -
  1. File Names: end in .R
    2. -
  2. Identifiers: variable.name - (or variableName), - FunctionName, kConstantName
    3. -
  3. Line Length: maximum 80 characters
    4. -
  4. Indentation: two spaces, no tabs
    5. -
  5. Spacing
    6. -
  6. Curly Braces: first on same line, last on - own line
    7. -
  7. else: Surround else with braces
    8. -
  8. Assignment: use <-, not - =
    9. -
  9. Semicolons: don't use them
    10. -
  10. General Layout and Ordering
    11. -
  11. Commenting Guidelines: all comments begin - with # followed by a space; inline comments need two - spaces before the #
    12. -
  12. Function Definitions and Calls
    13. -
  13. Function Documentation
    14. -
  14. Example Function
    15. -
  15. TODO Style: TODO(username)
    16. -
- -

Summary: R Language Rules

-
    -
  1. attach: avoid using it
    2. -
  2. Functions: - errors should be raised using stop()
    3. -
  3. Objects and Methods: avoid S4 objects and - methods when possible; never mix S3 and S4
    4. -
- -

Notation and Naming

- -

File Names

-

- File names should end in .R and, of course, be - meaningful. -
GOOD: predict_ad_revenue.R -
BAD: foo.R -

- -

Identifiers

-

- Don't use underscores ( _ ) or hyphens - ( - ) in identifiers. - Identifiers should be named according to the following conventions. - The preferred form for variable names is all lower case - letters and words separated with dots - (variable.name), but variableName - is also accepted; - function names have initial capital letters and no dots - (FunctionName); - constants are named like functions but with an initial - k. -

- - - -

Syntax

- -

Line Length

-

- The maximum line length is 80 characters. -

- -

Indentation

-

- When indenting your code, use two spaces. Never use tabs or mix - tabs and spaces. -
Exception: When a line break occurs inside parentheses, - align the wrapped line with the first character inside the - parenthesis. -

- -

Spacing

-

- Place spaces around all binary operators (=, - +, -, <-, etc.). -
Exception: Spaces around ='s are - optional when passing parameters in a function call. -

-

- Do not place a space before a comma, but always place one after a - comma. -

GOOD: -

-
tab.prior <- table(df[df$days.from.opt < 0, "campaign.id"])
-total <- sum(x[, 1])
-total <- sum(x[1, ])
-

- BAD: -

-
tab.prior <- table(df[df$days.from.opt<0, "campaign.id"])  # Needs spaces around '<'
-tab.prior <- table(df[df$days.from.opt < 0,"campaign.id"])  # Needs a space after the comma
-tab.prior<- table(df[df$days.from.opt < 0, "campaign.id"])  # Needs a space before <-
-tab.prior<-table(df[df$days.from.opt < 0, "campaign.id"])  # Needs spaces around <-
-total <- sum(x[,1])  # Needs a space after the comma
-total <- sum(x[ ,1])  # Needs a space after the comma, not before
-
-

- Place a space before left parenthesis, except in a function call. -

-

- GOOD: -
if (debug) -

-

- BAD: -
if(debug) -

-

- Extra spacing (i.e., more than one space in a row) is okay if it - improves alignment of equals signs or arrows (<-). -

-
plot(x    = x.coord,
-     y    = data.mat[, MakeColName(metric, ptiles[1], "roiOpt")],
-     ylim = ylim,
-     xlab = "dates",
-     ylab = metric,
-     main = (paste(metric, " for 3 samples ", sep = "")))
-
-

- Do not place spaces around code in parentheses or square brackets. -
Exception: Always place a space after a comma. -

-

- GOOD:

if (debug)
-x[1, ]
-

- BAD:

if ( debug )  # No spaces around debug
-x[1,]  # Needs a space after the comma
- -

Curly Braces

-

- An opening curly brace should never go on its own line; a closing - curly brace should always go on its own line. You may omit curly - braces when a block consists of a single statement; however, you - must consistently either use or not use curly braces for - single statement blocks. -

- 
-if (is.null(ylim)) {
-  ylim <- c(0, 0.06)
-}
-

- xor (but not both) -

- 
-if (is.null(ylim))
-  ylim <- c(0, 0.06)
-

- Always begin the body of a block on a new line. -

-

- BAD: -
if (is.null(ylim)) - ylim <- c(0, 0.06) -
if (is.null(ylim)) - {ylim <- c(0, 0.06)} -

- -

Surround else with braces

-

- An else statement should always be surrounded on the - same line by curly braces.

- 
-if (condition) {
-  one or more lines
-} else {
-  one or more lines
-}
-
-

- BAD:
-

- 
-if (condition) {
-  one or more lines
-}
-else {
-  one or more lines
-}
-
-

- BAD:
-

- 
-if (condition)
-  one line
-else
-  one line
-
- -

Assignment

-

- Use <-, not =, for assignment. -

-

- GOOD: -
x <- 5 -

-

- BAD: -
x = 5 -

-

Semicolons

-

- Do not terminate your lines with semicolons or use semicolons to - put more than one command on the same line. (Semicolons are not - necessary, and are omitted for consistency with other Google style - guides.) -

- - -

Organization

-

General Layout and Ordering

-

- If everyone uses the same general ordering, we'll be able to - read and understand each other's scripts faster and more easily. -

-
    -
  1. Copyright statement comment
    2. -
  2. Author comment
    3. -
  3. File description comment, including purpose of - program, inputs, and outputs
    4. -
  4. source() and library() statements
    5. -
  5. Function definitions
    6. -
  6. Executed statements, if applicable (e.g., - print, plot)
    7. -
-

- Unit tests should go in a separate file named - originalfilename_test.R. -

-

Commenting Guidelines

-

- Comment your code. Entire commented lines should begin with - # and one space. -

-

- Short comments can be placed after code preceded by two spaces, - #, and then one space. -

-
# Create histogram of frequency of campaigns by pct budget spent.
-hist(df$pct.spent,
-     breaks = "scott",  # method for choosing number of buckets
-     main   = "Histogram: fraction budget spent by campaignid",
-     xlab   = "Fraction of budget spent",
-     ylab   = "Frequency (count of campaignids)")
-
-

Function Definitions and - Calls

-

- Function definitions should first list arguments without default - values, followed by those with default values. -

-

- In both function definitions and function calls, multiple - arguments per line are allowed; line breaks are only allowed - between assignments. -
GOOD: -

-
PredictCTR <- function(query, property, num.days,
-                       show.plot = TRUE)
-
- BAD: -
PredictCTR <- function(query, property, num.days, show.plot =
-                       TRUE)
-
-

Ideally, unit tests should serve as sample function calls (for - shared library routines). -

-

Function Documentation

-

Functions should contain a comments section immediately below - the function definition line. These comments should consist of a - one-sentence description of the function; a list of the function's - arguments, denoted by Args:, with a description of - each (including the data type); and a description of the return - value, denoted by Returns:. The comments should be - descriptive enough that a caller can use the function without - reading any of the function's code. -

- -

Example Function

-
-CalculateSampleCovariance <- function(x, y, verbose = TRUE) {
-  # Computes the sample covariance between two vectors.
-  #
-  # Args:
-  #   x: One of two vectors whose sample covariance is to be calculated.
-  #   y: The other vector. x and y must have the same length, greater than one,
-  #      with no missing values.
-  #   verbose: If TRUE, prints sample covariance; if not, not. Default is TRUE.
-  #
-  # Returns:
-  #   The sample covariance between x and y.
-  n <- length(x)
-  # Error handling
-  if (n <= 1 || n != length(y)) {
-    stop("Arguments x and y have different lengths: ",
-         length(x), " and ", length(y), ".")
-  }
-  if (TRUE %in% is.na(x) || TRUE %in% is.na(y)) {
-    stop(" Arguments x and y must not have missing values.")
-  }
-  covariance <- var(x, y)
-  if (verbose)
-    cat("Covariance = ", round(covariance, 4), ".\n", sep = "")
-  return(covariance)
-}
-
- -

TODO Style

- -

- Use a consistent style for TODOs throughout your code. -
TODO(username): Explicit description of action to - be taken -

- - -

Language

- -

Attach

-

The possibilities for creating errors when using - attach are numerous. Avoid it.

-

Functions

-

Errors should be raised using stop().

-

Objects and Methods

-

The S language has two object systems, S3 and S4, both of which - are available in R. S3 methods are more interactive and flexible, - whereas S4 methods are more formal and rigorous. (For an illustration - of the two systems, see Thomas Lumley's - "Programmer's Niche: A Simple - Class, in S3 and S4" in R News 4/1, 2004, pgs. 33 - 36: - - http://cran.r-project.org/doc/Rnews/Rnews_2004-1.pdf.) -

-

Use S3 objects and methods unless there is a strong reason to use - S4 objects or methods. A primary justification for an S4 object - would be to use objects directly in C++ code. A primary - justification for an S4 generic/method would be to dispatch on two - arguments. -

-

Avoid mixing S3 and S4: S4 methods ignore S3 inheritance and - vice-versa. -

- - -

Exceptions

- -

- The coding conventions described above should be followed, unless - there is good reason to do otherwise. Exceptions include legacy - code and modifying third-party code. -

- - -

Parting Words

- -

- Use common sense and BE CONSISTENT. -

-

- If you are editing code, take a few minutes to look at the code around - you and determine its style. If others use spaces around their - if - clauses, you should, too. If their comments have little boxes of stars - around them, make your comments have little boxes of stars around them, - too. -

-

- The point of having style guidelines is to have a common vocabulary of - coding so people can concentrate on what you are saying, - rather than on how you are saying it. We present global style - rules here so people - know the vocabulary. But local style is also important. If code you add - to a file looks drastically different from the existing code around it, - the discontinuity will throw readers out of their rhythm when they go to - read it. Try to avoid this. -

- -

- OK, enough writing about writing code; the code itself is much more - interesting. Have fun! -

- - -

References

- -

- - http://www.maths.lth.se/help/R/RCC/ - R Coding Conventions -

-

- http://ess.r-project.org/ - For - emacs users. This runs R in your emacs and has an emacs mode. -

- - - - diff --git a/angularjs-google-style.asciidoc b/angularjs-google-style.asciidoc new file mode 100644 index 0000000..4fe7279 --- /dev/null +++ b/angularjs-google-style.asciidoc @@ -0,0 +1,328 @@ += An AngularJS Style Guide for Closure Users at Google +:sectlinks: + + +This is the external version of a document that was primarily written for Google engineers. It describes a recommended style for AngularJS apps that use Closure, as used internally at Google. Members of the broader AngularJS community should feel free to apply (or not apply) these recommendations, as relevant to their own use cases. + +This document describes style for AngularJS apps in google3. This guide supplements and extends the http://google-styleguide.googlecode.com/svn/trunk/javascriptguide.xml[Google JavaScript Style Guide]. + +**Style Note**: Examples on the AngularJS external webpage, and many external apps, are written in a style that freely uses closures, favors functional inheritance, and does not often use http://google-styleguide.googlecode.com/svn/trunk/javascriptguide.xml?showone=JavaScript_Types#JavaScript_Types[JavaScript types]. Google follows a more rigorous Javascript style to support JSCompiler optimizations and large code bases - see the javascript-style mailing list. This is not an Angular-specific issue, and is not discussed further in this style guide. (But if you want further reading: http://martinfowler.com/bliki/Lambda.html[Martin Fowler on closures], http://jibbering.com/faq/notes/closures/[much longer description], appendix A of the http://books.google.com/books/about/Closure_The_Definitive_Guide.html?id=p7uyWPcVGZsC[closure book] has a good description of inheritance patterns and why it prefers pseudoclassical, http://books.google.com/books/about/JavaScript.html?id=PXa2bby0oQ0C[Javascript, the Good Parts] as a counter.) + +===== 1 Angular Language Rules + +* link:#googprovide[Manage dependencies with Closure's goog.require and goog.provide] +* link:#modules[Modules] +* link:#moduledeps[Modules should reference other modules using the "name" property] +* link:#externs[Use the provided Angular externs file] +* link:#compilerflags[JSCompiler Flags] +* link:#controllers[Controllers and Scopes] +* link:#directives[Directives] +* link:#services[Services] + +===== 2 Angular Style Rules + +* link:#dollarsign[Reserve $ for Angular properties and services] +* link:#customelements[Custom elements.] + +===== 3 Angular Tips, Tricks, and Best Practices + +* link:#testing[Testing] +* link:#appstructure[Consider using the Best Practices for App Structure] +* link:#scopeinheritance[Be aware of how scope inheritance works] +* link:#nginject[Use @ngInject for easy dependency injection compilation] + +===== link:#bestpractices[4 Best practices links and docs] + +== 1 Angular Language Rules + +[[googprovide]] +=== Manage dependencies with Closure's goog.require and goog.provide + +Choose a namespace for your project, and use goog.provide and goog.require. + +---------------------------------------- +goog.provide('hello.about.AboutCtrl'); +goog.provide('hello.versions.Versions'); +---------------------------------------- + +*Why?* Google BUILD rules integrate nicely with closure provide/require. + +[[modules]] +=== Modules + +Your main application module should be in your root client directory. A module should never be altered other than the one where it is defined. + +Modules may either be defined in the same file as their components (this works well for a module that contains exactly one service) or in a separate file for wiring pieces together. + +*Why?* A module should be consistent for anyone that wants to include it as a reusable component. If a module can mean different things depending on which files are included, it is not consistent. + +[[moduledeps]] +=== Modules should reference other modules using the Angular Module's "name" property + +For example: + +----------------------------------------------------------------------------- +// file submodulea.js: + goog.provide('my.submoduleA'); + + my.submoduleA = angular.module('my.submoduleA', []); + // ... + +// file app.js + goog.require('my.submoduleA'); + + Yes: my.application.module = angular.module('hello', [my.submoduleA.name]); + + No: my.application.module = angular.module('hello', ['my.submoduleA']); + +----------------------------------------------------------------------------- + +*Why?* Using a property of my.submoduleA prevents Closure presubmit failures complaining that the file is required but never used. Using the .name property avoids duplicating strings. + +[[externs]] +=== Use a common externs file + +This maximally allows the JS compiler to enforce type safety in the presence of externally provided types from Angular, and means you don't have to worry about Angular vars being obfuscated in a confusing way. + +Note to readers outside Google: the current externs file is located in an internal-to-Google directory, but an example can be found on github https://github.com/angular/angular.js/pull/4722[here]. + +[[compilerflags]] +=== JSCompiler Flags + +**Reminder**: According to the JS style guide, customer facing code must be compiled. + +**Recommended**: Use the JSCompiler (the closure compiler that works with js_binary by default) and ANGULAR_COMPILER_FLAGS_FULL from //javascript/angular/build_defs/build_defs for your base flags. + +Note - if you are using @export for methods, you will need to add the compiler flag + +--------------------- +"--generate_exports", +--------------------- + +If you are using @export for properties, you will need to add the flags: + +--------------------------------------------------- +"--generate_exports", +"--remove_unused_prototype_props_in_externs=false", +"--export_local_property_definitions", +--------------------------------------------------- + +[[controllers]] +=== Controllers and Scopes + +Controllers are classes. Methods should be defined on MyCtrl.prototype. See http://google-styleguide.googlecode.com/svn/trunk/javascriptguide.xml?showone=Method_and_property_definitions#Method_and_property_definitions[the JavaScript style guide] + +Google Angular applications should use the *'controller as'* style to export the controller onto the scope. This is fully implemented in Angular 1.2 and can be mimicked in pre-Angular 1.2 builds. + +Pre Angular 1.2, this looks like: + +----------------------------------------------------------------------------- +/** + * Home controller. + * + * @param {!angular.Scope} $scope + * @constructor + * @ngInject + * @export + */ +hello.mainpage.HomeCtrl = function($scope) { + /** @export */ + $scope.homeCtrl = this; // This is a bridge until Angular 1.2 controller-as + + /** + * @type {string} + * @export + */ + this.myColor = 'blue'; +}; + + +/** + * @param {number} a + * @param {number} b + * @export + */ +hello.mainpage.HomeCtrl.prototype.add = function(a, b) { + return a + b; +}; +----------------------------------------------------------------------------- + +And the template: + +---------------------------------------------------------- +
+ I'm in a color! + {{homeCtrl.add(5, 6)}} +
+---------------------------------------------------------- + +After Angular 1.2, this looks like: + +-------------------------------------------------------- +/** + * Home controller. + * + * @constructor + * @ngInject + * @export + */ +hello.mainpage.HomeCtrl = function() { + /** + * @type {string} + * @export + */ + this.myColor = 'blue'; +}; + + +/** + * @param {number} a + * @param {number} b + * @export + */ +hello.mainpage.HomeCtrl.prototype.add = function(a, b) { + return a + b; +}; +-------------------------------------------------------- + +If you are compiling with property renaming, expose properties and methods using the @export annotation. Remember to @export the constructor as well. + +And in the template: + +---------------------------------------------------------- +
+ I'm in a color! + {{homeCtrl.add(5, 6)}} +
+---------------------------------------------------------- + +*Why?* Putting methods and properties directly onto the controller, instead of building up a scope object, fits better with the Google Closure class style. Additionally, using 'controller as' makes it obvious which controller you are accessing when multiple controllers apply to an element. Since there is always a '.' in the bindings, you don't have to worry about prototypal inheritance masking primitives. + +[[directives]] +=== Directives + +All DOM manipulation should be done inside directives. Directives should be kept small and use composition. Files defining directives should goog.provide a static function which returns the directive definition object. + +----------------------------------------------------------- +goog.provide('hello.pane.paneDirective'); + +/** + * Description and usage + * @return {angular.Directive} Directive definition object. + */ +hello.pane.paneDirective = function() { + // ... +}; +----------------------------------------------------------- + +**Exception**: DOM manipulation may occur in services for DOM elements disconnected from the rest of the view, e.g. dialogs or keyboard shortcuts. + +[[services]] +=== Services + +Services registered on the module with `module.service` are classes. Use `module.service` instead of `module.provider` or `module.factory` unless you need to do initialization beyond just creating a new instance of the class. + +----------------------------------------------------------- +/** + * @param {!angular.$http} $http The Angular http service. + * @constructor + */ +hello.request.Request = function($http) { + /** @type {!angular.$http} */ + this.http_ = $http; +}; + +hello.request.Request.prototype.get = function() {/*...*/}; +----------------------------------------------------------- + +In the module: + +------------------------------------------------- +module.service('request', hello.request.Request); +------------------------------------------------- + +== 2 Angular Style Rules + +[[dollarsign]] +=== Reserve $ for Angular properties and services + +Do not use $ to prepend your own object properties and service identifiers. Consider this style of naming reserved by AngularJS and jQuery. + +Yes: + +-------------------------------------------------------- + $scope.myModel = { value: 'foo' } + myModule.service('myService', function() { /*...*/ }); + var MyCtrl = function($http) {this.http_ = $http;}; +-------------------------------------------------------- + +No: + +------------------------------------------------------------- + $scope.$myModel = { value: 'foo' } // BAD + $scope.myModel = { $value: 'foo' } // BAD + myModule.service('$myService', function() { ... }); // BAD + var MyCtrl = function($http) {this.$http_ = $http;}; // BAD +------------------------------------------------------------- + +*Why?* It's useful to distinguish between Angular / jQuery builtins and things you add yourself. In addition, $ is not an acceptable character for variables names in the JS style guide. + +[[customelements]] +=== Custom elements + +For custom elements (e.g. ``), IE8 requires special support (html5shiv-like hacks) to enable css styling. Be aware of this restriction in apps targeting old versions of IE. + +== 3 Angular Tips, Tricks, and Best Practices + +These are not strict style guide rules, but are placed here as reference for folks getting started with Angular at Google. + +[[testing]] +=== Testing + +Angular is designed for test-driven development. + +The recommended unit testing setup is Jasmine + Karma (though you could use closure tests or js_test) + +Angular provides easy adapters to load modules and use the injector in Jasmine tests. + +* http://docs.angularjs.org/api/angular.mock.module[module] +* http://docs.angularjs.org/api/angular.mock.inject[inject] + +[[appstructure]] +=== Consider using the Best Practices for App Structure + +This https://docs.google.com/document/d/1XXMvReO8-Awi1EZXAXS4PzDzdNvV6pGcuaF4Q9821Es/pub[directory structure doc] describes how to structure your application with controllers in nested subdirectories and all components (e.g. services and directives) in a 'components' dir. + +[[scopeinheritance]] +=== Be aware of how scope inheritance works + +See https://github.com/angular/angular.js/wiki/Understanding-Scopes#wiki-JSproto[The Nuances of Scope Prototypal Inheritance] + +[[nginject]] +=== Use @ngInject for easy dependency injection compilation + +This removes the need to add `myCtrl['$inject'] = ...` to prevent minification from messing up Angular's dependency injection. + +Usage: + +-------------------------------------------- +/** + * My controller. + * @param {!angular.$http} $http + * @param {!my.app.myService} myService + * @constructor + * @export + * @ngInject + */ +my.app.MyCtrl = function($http, myService) { + //... +}; +-------------------------------------------- + +[[bestpractices]] +== 4 Best practices links and docs + +* https://github.com/angular/angular.js/wiki/Best-Practices[Best Practices] from Angular on GitHub +* http://www.youtube.com/watch?v=ZhfUv0spHCY[Meetup video] (not Google specific) + +Last modified Feb 07 2013 diff --git a/angularjs-google-style.html b/angularjs-google-style.html deleted file mode 100644 index 47db589..0000000 --- a/angularjs-google-style.html +++ /dev/null @@ -1,395 +0,0 @@ - - - - - - - - - - Google's AngularJS Style Guide - - - -

An AngularJS Style Guide for Closure Users at Google

- -

This is the external version of a document that was primarily written for Google - engineers. It describes a recommended style for AngularJS apps that use Closure, as used - internally at Google. Members of the broader AngularJS community should feel free to apply - (or not apply) these recommendations, as relevant to their own use cases.

- -

This document describes style for AngularJS apps in google3. This guide - supplements and extends the - Google JavaScript Style Guide. -

- -

Style Note: Examples on the AngularJS external webpage, and many external apps, are - written in a style that freely uses closures, favors functional inheritance, and does not often use - - JavaScript types. Google follows a more rigorous Javascript style to support JSCompiler - optimizations and large code bases - see the javascript-style mailing list. - This is not an Angular-specific issue, and is not discussed further in this style guide. - (But if you want further reading: - Martin Fowler on closures, - much longer description, appendix A of the - - closure book has a good description of inheritance patterns and why it prefers - pseudoclassical, - - Javascript, the Good Parts as a counter.)

- -
1 Angular Language Rules
- -
2 Angular Style Rules
- -
3 Angular Tips, Tricks, and Best Practices
- - -
4 Best practices links and docs
- -

1 Angular Language Rules

- -

Manage dependencies with Closure's goog.require and goog.provide

-

Choose a namespace for your project, and use goog.provide and goog.require.

-
-goog.provide('hello.about.AboutCtrl');
-goog.provide('hello.versions.Versions');
-
- -

Why? - Google BUILD rules integrate nicely with closure provide/require.

- -

Modules

- -

Your main application module should be in your root client directory. A module should never be - altered other than the one where it is defined.

- -

Modules may either be defined in the same file as their components (this works well for a module - that contains exactly one service) or in a separate file for wiring pieces together.

- -

Why? - A module should be consistent for anyone that wants to include it as a reusable component. - If a module can mean different things depending on which files are included, it is not consistent. -

- -

- Modules should reference other modules using the Angular Module's "name" property -

- -

For example:

- -
-// file submodulea.js:
-  goog.provide('my.submoduleA');
-
-  my.submoduleA = angular.module('my.submoduleA', []);
-  // ...
-
-// file app.js
-  goog.require('my.submoduleA');
-
-  Yes: my.application.module = angular.module('hello', [my.submoduleA.name]);
-  
-      No: my.application.module = angular.module('hello', ['my.submoduleA']);
-
- -

Why? - Using a property of my.submoduleA prevents Closure presubmit failures complaining that the file is - required but never used. Using the .name property avoids duplicating strings.

- -

Use a common externs file

- -

This maximally allows the JS compiler to enforce type safety in the presence of externally - provided types from Angular, and means you don't have to worry about Angular vars being obfuscated - in a confusing way.

- -

Note to readers outside Google: the current externs file is located in an internal-to-Google - directory, but an example can be found on github - here.

- -

JSCompiler Flags

-

Reminder: According to the JS style guide, customer facing code must be compiled.

- -

Recommended: Use the JSCompiler (the closure compiler that works with js_binary by - default) and ANGULAR_COMPILER_FLAGS_FULL from //javascript/angular/build_defs/build_defs for - your base flags. -

- -

Note - if you are using @export for methods, you will need to add the compiler flag

-
-"--generate_exports",
-
- -

If you are using @export for properties, you will need to add the flags:

-
-"--generate_exports",
-"--remove_unused_prototype_props_in_externs=false",
-"--export_local_property_definitions",
-
- -

Controllers and Scopes

-

Controllers are classes. Methods should be defined on MyCtrl.prototype. - See - the JavaScript style guide

- -

Google Angular applications should use the 'controller as' style to export the controller - onto the scope. This is fully implemented in Angular 1.2 and can be mimicked in pre-Angular 1.2 - builds. -

- -

Pre Angular 1.2, this looks like:

-
-/**
- * Home controller.
- *
- * @param {!angular.Scope} $scope
- * @constructor
- * @ngInject
- * @export
- */
-hello.mainpage.HomeCtrl = function($scope) {
-  /** @export */
-  $scope.homeCtrl = this; // This is a bridge until Angular 1.2 controller-as
-
-  /**
-   * @type {string}
-   * @export
-   */
-  this.myColor = 'blue';
-};
-
-
-/**
- * @param {number} a
- * @param {number} b
- * @export
- */
-hello.mainpage.HomeCtrl.prototype.add = function(a, b) {
-  return a + b;
-};
-
- -

And the template:

- -
-<div ng-controller="hello.mainpage.HomeCtrl"/>
-  <span ng-class="homeCtrl.myColor">I'm in a color!</span>
-  <span>{{homeCtrl.add(5, 6)}}</span>
-</div>
-
- -

After Angular 1.2, this looks like:

- -
-/**
- * Home controller.
- *
- * @constructor
- * @ngInject
- * @export
- */
-hello.mainpage.HomeCtrl = function() {
-  /**
-   * @type {string}
-   * @export
-   */
-  this.myColor = 'blue';
-};
-
-
-/**
- * @param {number} a
- * @param {number} b
- * @export
- */
-hello.mainpage.HomeCtrl.prototype.add = function(a, b) {
-  return a + b;
-};
-
- -

If you are compiling with property renaming, expose properties and methods using the @export - annotation. Remember to @export the constructor as well.

- -

And in the template:

- -
-<div ng-controller="hello.mainpage.HomeCtrl as homeCtrl"/>
-  <span ng-class="homeCtrl.myColor">I'm in a color!</span>
-  <span>{{homeCtrl.add(5, 6)}}</span>
-</div>
-
- -

Why? - Putting methods and properties directly onto the controller, instead of building up a scope - object, fits better with the Google Closure class style. Additionally, using 'controller as' - makes it obvious which controller you are accessing when multiple controllers apply to an element. - Since there is always a '.' in the bindings, you don't have to worry about prototypal inheritance - masking primitives.

- -

Directives

- -

All DOM manipulation should be done inside directives. Directives should be kept small and use - composition. Files defining directives should goog.provide a static function which returns the - directive definition object.

- -
-goog.provide('hello.pane.paneDirective');
-
-/**
- * Description and usage
- * @return {angular.Directive} Directive definition object.
- */
-hello.pane.paneDirective = function() {
-  // ...
-};
-
- -

Exception: DOM manipulation may occur in services for DOM elements disconnected from the - rest of the view, e.g. dialogs or keyboard shortcuts.

- -

Services

- -

Services registered on the module with module.service are classes. - Use module.service instead of module.provider or - module.factory unless you need to do initialization beyond just creating a - new instance of the class.

- -
-/**
- * @param {!angular.$http} $http The Angular http service.
- * @constructor
- */
-hello.request.Request = function($http) {
-  /** @type {!angular.$http} */
-  this.http_ = $http;
-};
-
-hello.request.Request.prototype.get = function() {/*...*/};
-
- -

In the module:

- -
-module.service('request', hello.request.Request);
-
- - -

2 Angular Style Rules

- -

Reserve $ for Angular properties and services

-

Do not use $ to prepend your own object properties and service identifiers. Consider this style - of naming reserved by AngularJS and jQuery.

- -

Yes:

-
-  $scope.myModel = { value: 'foo' }
-  myModule.service('myService', function() { /*...*/ });
-  var MyCtrl = function($http) {this.http_ = $http;};
-
- -

No:

-
-  $scope.$myModel = { value: 'foo' } // BAD
-  $scope.myModel = { $value: 'foo' } // BAD
-  myModule.service('$myService', function() { ... }); // BAD
-  var MyCtrl = function($http) {this.$http_ = $http;}; // BAD
-
- -

Why? - It's useful to distinguish between Angular / jQuery builtins and things you add yourself. - In addition, $ is not an acceptable character for variables names in the JS style guide. -

- -

Custom elements

- -

For custom elements (e.g. <ng-include src="template"></ng-include>), IE8 - requires special support (html5shiv-like hacks) to enable css styling. Be aware of this - restriction in apps targeting old versions of IE.

- -

3 Angular Tips, Tricks, and Best Practices

- -

These are not strict style guide rules, but are placed here as reference for folks getting - started with Angular at Google.

- -

Testing

- -

Angular is designed for test-driven development.

- -

The recommended unit testing setup is Jasmine + Karma (though you could use closure tests - or js_test)

- -

Angular provides easy adapters to load modules and use the injector in Jasmine tests. -

-

- - -

Consider using the Best Practices for App Structure

-

- This directory structure doc describes how to structure your application with controllers in - nested subdirectories and all components (e.g. services and directives) in a 'components' dir. -

- - -

Be aware of how scope inheritance works

- -

See - The Nuances of Scope Prototypal Inheritance

- -

Use @ngInject for easy dependency injection compilation

-

This removes the need to add myCtrl['$inject'] = ... to prevent minification from - messing up Angular's dependency injection.

- -

Usage:

-
-/**
- * My controller.
- * @param {!angular.$http} $http
- * @param {!my.app.myService} myService
- * @constructor
- * @export
- * @ngInject
- */
-my.app.MyCtrl = function($http, myService) {
-  //...
-};
-
- -

4 Best practices links and docs

- - -
- Last modified Feb 07 2013 -
- - diff --git a/cppguide.asciidoc b/cppguide.asciidoc new file mode 100644 index 0000000..beebe03 --- /dev/null +++ b/cppguide.asciidoc @@ -0,0 +1,2861 @@ +:cpp: C++ + += Google {cpp} Style Guide +:sectlinks: + +[[Background]] +== Background + +{cpp} is the main development language used by many of Google's open-source projects. As every {cpp} programmer knows, the language has many powerful features, but this power brings with it complexity, which in turn can make code more bug-prone and harder to read and maintain. + +The goal of this guide is to manage this complexity by describing in detail the dos and don'ts of writing {cpp} code. These rules exist to keep the code base manageable while still allowing coders to use {cpp} language features productively. + +__Style__, also known as readability, is what we call the conventions that govern our {cpp} code. The term Style is a bit of a misnomer, since these conventions cover far more than just source file formatting. + +Most open-source projects developed by Google conform to the requirements in this guide. + +Note that this guide is not a {cpp} tutorial: we assume that the reader is familiar with the language. + +[[Goals]] +=== Goals of the Style Guide + +Why do we have this document? + +There are a few core goals that we believe this guide should serve. These are the fundamental **why**s that underlie all of the individual rules. By bringing these ideas to the fore, we hope to ground discussions and make it clearer to our broader community why the rules are in place and why particular decisions have been made. If you understand what goals each rule is serving, it should be clearer to everyone when a rule may be waived (some can be), and what sort of argument or alternative would be necessary to change a rule in the guide. + +The goals of the style guide as we currently see them are as follows: + +Style rules should pull their weight:: + The benefit of a style rule must be large enough to justify asking all of our engineers to remember it. The benefit is measured relative to the codebase we would get without the rule, so a rule against a very harmful practice may still have a small benefit if people are unlikely to do it anyway. This principle mostly explains the rules we don’t have, rather than the rules we do: for example, `goto` contravenes many of the following principles, but is already vanishingly rare, so the Style Guide doesn’t discuss it. +Optimize for the reader, not the writer:: + Our codebase (and most individual components submitted to it) is expected to continue for quite some time. As a result, more time will be spent reading most of our code than writing it. We explicitly choose to optimize for the experience of our average software engineer reading, maintaining, and debugging code in our codebase rather than ease when writing said code. "Leave a trace for the reader" is a particularly common sub-point of this principle: When something surprising or unusual is happening in a snippet of code (for example, transfer of pointer ownership), leaving textual hints for the reader at the point of use is valuable (`std::unique_ptr` demonstrates the ownership transfer unambiguously at the call site). +Be consistent with existing code:: + Using one style consistently through our codebase lets us focus on other (more important) issues. Consistency also allows for automation: tools that format your code or adjust your `#include`s only work properly when your code is consistent with the expectations of the tooling. In many cases, rules that are attributed to "Be Consistent" boil down to "Just pick one and stop worrying about it"; the potential value of allowing flexibility on these points is outweighed by the cost of having people argue over them. +Be consistent with the broader {cpp} community when appropriate:: + Consistency with the way other organizations use {cpp} has value for the same reasons as consistency within our code base. If a feature in the {cpp} standard solves a problem, or if some idiom is widely known and accepted, that's an argument for using it. However, sometimes standard features and idioms are flawed, or were just designed without our codebase's needs in mind. In those cases (as described below) it's appropriate to constrain or ban standard features. In some cases we prefer a homegrown or third-party library over a library defined in the {cpp} Standard, either out of perceived superiority or insufficient value to transition the codebase to the standard interface. +Avoid surprising or dangerous constructs:: + {cpp} has features that are more surprising or dangerous than one might think at a glance. Some style guide restrictions are in place to prevent falling into these pitfalls. There is a high bar for style guide waivers on such restrictions, because waiving such rules often directly risks compromising program correctness. +Avoid constructs that our average {cpp} programmer would find tricky or hard to maintain:: + {cpp} has features that may not be generally appropriate because of the complexity they introduce to the code. In widely used code, it may be more acceptable to use trickier language constructs, because any benefits of more complex implementation are multiplied widely by usage, and the cost in understanding the complexity does not need to be paid again when working with new portions of the codebase. When in doubt, waivers to rules of this type can be sought by asking your project leads. This is specifically important for our codebase because code ownership and team membership changes over time: even if everyone that works with some piece of code currently understands it, such understanding is not guaranteed to hold a few years from now. +Be mindful of our scale:: + With a codebase of 100+ million lines and thousands of engineers, some mistakes and simplifications for one engineer can become costly for many. For instance it's particularly important to avoid polluting the global namespace: name collisions across a codebase of hundreds of millions of lines are difficult to work with and hard to avoid if everyone puts things into the global namespace. +Concede to optimization when necessary:: + Performance optimizations can sometimes be necessary and appropriate, even when they conflict with the other principles of this document. + +The intent of this document is to provide maximal guidance with reasonable restriction. As always, common sense and good taste should prevail. By this we specifically refer to the established conventions of the entire Google {cpp} community, not just your personal preferences or those of your team. Be skeptical about and reluctant to use clever or unusual constructs: the absence of a prohibition is not the same as a license to proceed. Use your judgment, and if you are unsure, please don't hesitate to ask your project leads to get additional input. + +[[Header_Files]] +== Header Files + +In general, every `.cc` file should have an associated `.h` file. There are some common exceptions, such as unittests and small `.cc` files containing just a `main()` function. + +Correct use of header files can make a huge difference to the readability, size and performance of your code. + +The following rules will guide you through the various pitfalls of using header files. + +[[Self_contained_Headers]] +=== Self-contained Headers + +Header files should be self-contained and end in `.h`. Files that are meant for textual inclusion, but are not headers, should end in `.inc`. Separate `-inl.h` headers are disallowed. + +All header files should be self-contained. In other words, users and refactoring tools should not have to adhere to special conditions in order to include the header. Specifically, a header should have link:#The__define_Guard[header guards], should include all other headers it needs, and should not require any particular symbols to be defined. + +There are rare cases where a file is not meant to be self-contained, but instead is meant to be textually included at a specific point in the code. Examples are files that need to be included multiple times or platform-specific extensions that essentially are part of other headers. Such files should use the file extension `.inc`. + +If a template or inline function is declared in a `.h` file, define it in that same file. The definitions of these constructs must be included into every `.cc` file that uses them, or the program may fail to link in some build configurations. Do not move these definitions to separate `-inl.h` files. + +As an exception, a function template that is explicitly instantiated for all relevant sets of template arguments, or that is a private member of a class, may be defined in the only `.cc` file that instantiates the template. + +[[The__define_Guard]] +=== The #define Guard + +All header files should have `#define` guards to prevent multiple inclusion. The format of the symbol name should be `___H_`. + +To guarantee uniqueness, they should be based on the full path in a project's source tree. For example, the file `foo/src/bar/baz.h` in project `foo` should have the following guard: + +------------------------- +#ifndef FOO_BAR_BAZ_H_ +#define FOO_BAR_BAZ_H_ + +... + +#endif // FOO_BAR_BAZ_H_ +------------------------- + +[[Forward_Declarations]] +=== Forward Declarations + +Avoid using forward declarations where possible. Just `#include` the headers you need. + +A "forward declaration" is a declaration of a class, function, or template without an associated definition. + +* Forward declarations can save compile time, as `#include`s force the compiler to open more files and process more input. +* Forward declarations can save on unnecessary recompilation. `#include`s can force your code to be recompiled more often, due to unrelated changes in the header. + +* Forward declarations can hide a dependency, allowing user code to skip necessary recompilation when headers change. +* A forward declaration may be broken by subsequent changes to the library. Forward declarations of functions and templates can prevent the header owners from making otherwise-compatible changes to their APIs, such as widening a parameter type, adding a template parameter with a default value, or migrating to a new namespace. +* Forward declaring symbols from namespace `std::` yields undefined behavior. +* It can be difficult to determine whether a forward declaration or a full `#include` is needed. Replacing an `#include` with a forward declaration can silently change the meaning of code: ++ +----------------------------------------------- + // b.h: + struct B {}; + struct D : B {}; + + // good_user.cc: + #include "b.h" + void f(B*); + void f(void*); + void test(D* x) { f(x); } // calls f(B*) + +----------------------------------------------- ++ +If the `#include` was replaced with forward decls for `B` and `D`, `test()` would call `f(void*)`. +* Forward declaring multiple symbols from a header can be more verbose than simply `#include`ing the header. +* Structuring code to enable forward declarations (e.g. using pointer members instead of object members) can make the code slower and more complex. + +* Try to avoid forward declarations of entities defined in another project. +* When using a function declared in a header file, always `#include` that header. +* When using a class template, prefer to `#include` its header file. + +Please see link:#Names_and_Order_of_Includes[Names and Order of Includes] for rules about when to #include a header. + +[[Inline_Functions]] +=== Inline Functions + +Define functions inline only when they are small, say, 10 lines or less. + +You can declare functions in a way that allows the compiler to expand them inline rather than calling them through the usual function call mechanism. + +Inlining a function can generate more efficient object code, as long as the inlined function is small. Feel free to inline accessors and mutators, and other short, performance-critical functions. + +Overuse of inlining can actually make programs slower. Depending on a function's size, inlining it can cause the code size to increase or decrease. Inlining a very small accessor function will usually decrease code size while inlining a very large function can dramatically increase code size. On modern processors smaller code usually runs faster due to better use of the instruction cache. + +A decent rule of thumb is to not inline a function if it is more than 10 lines long. Beware of destructors, which are often longer than they appear because of implicit member- and base-destructor calls! + +Another useful rule of thumb: it's typically not cost effective to inline functions with loops or switch statements (unless, in the common case, the loop or switch statement is never executed). + +It is important to know that functions are not always inlined even if they are declared as such; for example, virtual and recursive functions are not normally inlined. Usually recursive functions should not be inline. The main reason for making a virtual function inline is to place its definition in the class, either for convenience or to document its behavior, e.g., for accessors and mutators. + +[[Names_and_Order_of_Includes]] +=== Names and Order of Includes + +Use standard order for readability and to avoid hidden dependencies: Related header, C library, {cpp} library, other libraries' `.h`, your project's `.h`. + +All of a project's header files should be listed as descendants of the project's source directory without use of UNIX directory shortcuts `.` (the current directory) or `..` (the parent directory). For example, `google-awesome-project/src/base/logging.h` should be included as: + +------------------------- +#include "base/logging.h" +------------------------- + +In `dir/foo.cc` or `dir/foo_test.cc`, whose main purpose is to implement or test the stuff in `dir2/foo2.h`, order your includes as follows: + +1. `dir2/foo2.h`. +2. C system files. +3. {cpp} system files. +4. Other libraries' `.h` files. +5. Your project's `.h` files. + +With the preferred ordering, if `dir2/foo2.h` omits any necessary includes, the build of `dir/foo.cc` or `dir/foo_test.cc` will break. Thus, this rule ensures that build breaks show up first for the people working on these files, not for innocent people in other packages. + +`dir/foo.cc` and `dir2/foo2.h` are usually in the same directory (e.g. `base/basictypes_test.cc` and `base/basictypes.h`), but may sometimes be in different directories too. + +Within each section the includes should be ordered alphabetically. Note that older code might not conform to this rule and should be fixed when convenient. + +You should include all the headers that define the symbols you rely upon, except in the unusual case of link:#Forward_Declarations[forward declaration]. If you rely on symbols from `bar.h`, don't count on the fact that you included `foo.h` which (currently) includes `bar.h`: include `bar.h` yourself, unless `foo.h` explicitly demonstrates its intent to provide you the symbols of `bar.h`. However, any includes present in the related header do not need to be included again in the related `cc` (i.e., `foo.cc` can rely on `foo.h`'s includes). + +For example, the includes in `google-awesome-project/src/foo/internal/fooserver.cc` might look like this: + +---------------------------------- +#include "foo/server/fooserver.h" + +#include +#include +#include +#include + +#include "base/basictypes.h" +#include "base/commandlineflags.h" +#include "foo/server/bar.h" +---------------------------------- + +Sometimes, system-specific code needs conditional includes. Such code can put conditional includes after other includes. Of course, keep your system-specific code small and localized. Example: + +------------------------------------------ +#include "foo/public/fooserver.h" + +#include "base/port.h" // For LANG_CXX11. + +#ifdef LANG_CXX11 +#include +#endif // LANG_CXX11 +------------------------------------------ + +[[Scoping]] +== Scoping + +[[Namespaces]] +=== Namespaces + +With few exceptions, place code in a namespace. Namespaces should have unique names based on the project name, and possibly its path. Unnamed namespaces in `.cc` files are encouraged. Do not use __using-directives__. Do not use inline namespaces. + +Namespaces subdivide the global scope into distinct, named scopes, and so are useful for preventing name collisions in the global scope. + +Namespaces provide a method for preventing name conflicts in large programs while allowing most code to use reasonably short names. + +For example, if two different projects have a class `Foo` in the global scope, these symbols may collide at compile time or at runtime. If each project places their code in a namespace, `project1::Foo` and `project2::Foo` are now distinct symbols that do not collide, and code within each project's namespace can continue to refer to `Foo` without the prefix. + +Inline namespaces automatically place their names in the enclosing scope. Consider the following snippet, for example: + +-------------------- +namespace X { +inline namespace Y { + void foo(); +} +} +-------------------- + +The expressions `X::Y::foo()` and `X::foo()` are interchangeable. Inline namespaces are primarily intended for ABI compatibility across versions. + +Namespaces can be confusing, because they complicate the mechanics of figuring out what definition a name refers to. + +Inline namespaces, in particular, can be confusing because names aren't actually restricted to the namespace where they are declared. They are only useful as part of some larger versioning policy. + +Use of unnamed namespaces in header files can easily cause violations of the {cpp} One Definition Rule (ODR). + +In some contexts, it's necessary to repeatedly refer to symbols by their fully-qualified names. For deeply-nested namespaces, this can add a lot of clutter. + +Use namespaces according to the policy described below. Terminate namespaces with comments as shown in the given examples. See also the rules on link:#Namespace_Names[Namespace Names]. + +==== Unnamed Namespaces + +* Unnamed namespaces are allowed and even encouraged in `.cc` files, to avoid link time naming conflicts: ++ +----------------------------------------------------------------- +namespace { // This is in a .cc file. + +// The content of a namespace is not indented. +// +// This function is guaranteed not to generate a colliding symbol +// with other symbols at link time, and is only visible to +// callers in this .cc file. +bool UpdateInternals(Frobber* f, int newval) { + ... +} + +} // namespace +----------------------------------------------------------------- +* Do not use unnamed namespaces in `.h` files. + +==== Named Namespaces + +Named namespaces should be used as follows: + +* Namespaces wrap the entire source file after includes, http://google-gflags.googlecode.com/[gflags] definitions/declarations and forward declarations of classes from other namespaces. ++ +--------------------------------------------------- +// In the .h file +namespace mynamespace { + +// All declarations are within the namespace scope. +// Notice the lack of indentation. +class MyClass { + public: + ... + void Foo(); +}; + +} // namespace mynamespace +--------------------------------------------------- ++ +------------------------------------------------------------ +// In the .cc file +namespace mynamespace { + +// Definition of functions is within scope of the namespace. +void MyClass::Foo() { + ... +} + +} // namespace mynamespace +------------------------------------------------------------ ++ +More complex `.cc` files might have additional details, like flags or using-declarations. ++ +-------------------------------------------------------------- +#include "a.h" + +DEFINE_bool(someflag, false, "dummy flag"); + +using ::foo::bar; + +namespace a { + +...code for a... // Code goes against the left margin. + +} // namespace a +-------------------------------------------------------------- +* Do not declare anything in namespace `std`, including forward declarations of standard library classes. Declaring entities in namespace `std` is undefined behavior, i.e., not portable. To declare entities from the standard library, include the appropriate header file. +* You may not use a _using-directive_ to make all names from a namespace available. ++ +-------------------------------------------- +// Forbidden -- This pollutes the namespace. +using namespace foo; +-------------------------------------------- +* You may use a _using-declaration_ anywhere in a `.cc` file (including in the global namespace), and in functions, methods, classes, or within internal namespaces in `.h` files. ++ +Do not use using-declarations in `.h` files except in explicitly marked internal-only namespaces, because anything imported into a namespace in a `.h` file becomes part of the public API exported by that file. ++ +-------------------------------------------------------- +// OK in .cc files. +// Must be in a function, method, internal namespace, or +// class in .h files. +using ::foo::bar; +-------------------------------------------------------- +* _Namespace aliases_ are allowed anywhere where a _using-declaration_ is allowed. In particular, namespace aliases should not be used at namespace scope in `.h` files except in explicitly marked internal-only namespaces. ++ +----------------------------------------------------------- +// Shorten access to some commonly used names in .cc files. +namespace baz = ::foo::bar::baz; +----------------------------------------------------------- ++ +------------------------------------------------------------- +// Shorten access to some commonly used names (in a .h file). +namespace librarian { +namespace impl { // Internal, not part of the API. +namespace sidetable = ::pipeline_diagnostics::sidetable; +} // namespace impl + +inline void my_inline_function() { + // namespace alias local to a function (or method). + namespace baz = ::foo::bar::baz; + ... +} +} // namespace librarian +------------------------------------------------------------- +* Do not use inline namespaces. + +[[Nonmember,_Static_Member,_and_Global_Functions]] +=== Nonmember, Static Member, and Global Functions + +Prefer placing nonmember functions in a namespace; use completely global functions rarely. Prefer grouping functions with a namespace instead of using a class as if it were a namespace. Static methods of a class should generally be closely related to instances of the class or the class's static data. + +Nonmember and static member functions can be useful in some situations. Putting nonmember functions in a namespace avoids polluting the global namespace. + +Nonmember and static member functions may make more sense as members of a new class, especially if they access external resources or have significant dependencies. + +Sometimes it is useful, or even necessary, to define a function not bound to a class instance. Such a function can be either a static member or a nonmember function. Nonmember functions should not depend on external variables, and should nearly always exist in a namespace. Rather than creating classes only to group static member functions which do not share static data, use link:#Namespaces[namespaces] instead. For a header `myproject/foo_bar.h`, for example, write + +--------------------- +namespace myproject { +namespace foo_bar { +void Function1(); +void Function2(); +} +} +--------------------- + +instead of + +-------------------------- +namespace myproject { +class FooBar { + public: + static void Function1(); + static void Function2(); +}; +} +-------------------------- + +If you must define a nonmember function and it is only needed in its `.cc` file, use an unnamed link:#Namespaces[namespace] or `static` linkage (eg `static int Foo() {...}`) to limit its scope. + +[[Local_Variables]] +=== Local Variables + +Place a function's variables in the narrowest scope possible, and initialize variables in the declaration. + +{cpp} allows you to declare variables anywhere in a function. We encourage you to declare them in as local a scope as possible, and as close to the first use as possible. This makes it easier for the reader to find the declaration and see what type the variable is and what it was initialized to. In particular, initialization should be used instead of declaration and assignment, e.g.: + +----------------------------------------------------------------- +int i; +i = f(); // Bad -- initialization separate from declaration. +----------------------------------------------------------------- + +-------------------------------------------------------- +int j = g(); // Good -- declaration has initialization. +-------------------------------------------------------- + +------------------------------------------------------------------- +vector v; +v.push_back(1); // Prefer initializing using brace initialization. +v.push_back(2); +------------------------------------------------------------------- + +--------------------------------------------------------- +vector v = {1, 2}; // Good -- v starts initialized. +--------------------------------------------------------- + +Variables needed for `if`, `while` and `for` statements should normally be declared within those statements, so that such variables are confined to those scopes. E.g.: + +----------------------------------------------------- +while (const char* p = strchr(str, '/')) str = p + 1; +----------------------------------------------------- + +There is one caveat: if the variable is an object, its constructor is invoked every time it enters scope and is created, and its destructor is invoked every time it goes out of scope. + +------------------------------------------------------------ +// Inefficient implementation: +for (int i = 0; i < 1000000; ++i) { + Foo f; // My ctor and dtor get called 1000000 times each. + f.DoSomething(i); +} +------------------------------------------------------------ + +It may be more efficient to declare such a variable used in a loop outside that loop: + +------------------------------------------------- +Foo f; // My ctor and dtor get called once each. +for (int i = 0; i < 1000000; ++i) { + f.DoSomething(i); +} +------------------------------------------------- + +[[Static_and_Global_Variables]] +=== Static and Global Variables + +Variables of class type with http://en.cppreference.com/w/cpp/language/storage_duration#Storage_duration[static storage duration] are forbidden: they cause hard-to-find bugs due to indeterminate order of construction and destruction. However, such variables are allowed if they are `constexpr`: they have no dynamic initialization or destruction. + +Objects with static storage duration, including global variables, static variables, static class member variables, and function static variables, must be Plain Old Data (POD): only ints, chars, floats, or pointers, or arrays/structs of POD. + +The order in which class constructors and initializers for static variables are called is only partially specified in {cpp} and can even change from build to build, which can cause bugs that are difficult to find. Therefore in addition to banning globals of class type, we do not allow static POD variables to be initialized with the result of a function, unless that function (such as getenv(), or getpid()) does not itself depend on any other globals. (This prohibition does not apply to a static variable within function scope, since its initialization order is well-defined and does not occur until control passes through its declaration.) + +Likewise, global and static variables are destroyed when the program terminates, regardless of whether the termination is by returning from `main()` or by calling `exit()`. The order in which destructors are called is defined to be the reverse of the order in which the constructors were called. Since constructor order is indeterminate, so is destructor order. For example, at program-end time a static variable might have been destroyed, but code still running — perhaps in another thread — tries to access it and fails. Or the destructor for a static `string` variable might be run prior to the destructor for another variable that contains a reference to that string. + +One way to alleviate the destructor problem is to terminate the program by calling `quick_exit()` instead of `exit()`. The difference is that `quick_exit()` does not invoke destructors and does not invoke any handlers that were registered by calling `atexit()`. If you have a handler that needs to run when a program terminates via `quick_exit()` (flushing logs, for example), you can register it using `at_quick_exit()`. (If you have a handler that needs to run at both `exit()` and `quick_exit()`, you need to register it in both places.) + +As a result we only allow static variables to contain POD data. This rule completely disallows `vector` (use C arrays instead), or `string` (use `const char []`). + +If you need a static or global variable of a class type, consider initializing a pointer (which will never be freed), from either your main() function or from pthread_once(). Note that this must be a raw pointer, not a "smart" pointer, since the smart pointer's destructor will have the order-of-destructor issue that we are trying to avoid. + +[[Classes]] +== Classes + +Classes are the fundamental unit of code in {cpp}. Naturally, we use them extensively. This section lists the main dos and don'ts you should follow when writing a class. + +[[Doing_Work_in_Constructors]] +=== Doing Work in Constructors + +Avoid virtual method calls in constructors, and avoid initialization that can fail if you can't signal an error. + +It is possible to perform arbitrary initialization in the body of the constructor. + +* No need to worry about whether the class has been initialized or not. +* Objects that are fully initialized by constructor call can be `const` and may also be easier to use with standard containers or algorithms. + +The problems with doing work in constructors are: + +* If the work calls virtual functions, these calls will not get dispatched to the subclass implementations. Future modification to your class can quietly introduce this problem even if your class is not currently subclassed, causing much confusion. +* There is no easy way for constructors to signal errors, short of crashing the program (not always appropriate) or using exceptions (which are link:#Exceptions[forbidden]). +* If the work fails, we now have an object whose initialization code failed, so it may be an unusual state requiring a `bool IsValid()` state checking mechanism (or similar) which is easy to forget to call. +* You cannot take address of a constructor, so whatever work is done in the constructor cannot easily be handed off to, for example, another thread. + +Constructors should never call virtual functions. If appropriate for your code , terminating the program may be an appropriate error handling response. Otherwise, consider a factory function or `Init()` method. Avoid `Init()` methods on objects with no other states that affect which public methods may be called (semi-constructed objects of this form are particularly hard to work with correctly). + +[[Implicit_Conversions]] +=== Implicit Conversions + +Do not define implicit conversions. Use the `explicit` keyword for conversion operators and single-argument constructors. + +Implicit conversions allow an object of one type (called the source type) to be used where a different type (called the destination type) is expected, such as when passing an `int` argument to a function that takes a `double` parameter. + +In addition to the implicit conversions defined by the language, users can define their own, by adding appropriate members to the class definition of the source or destination type. An implicit conversion in the source type is defined by a type conversion operator named after the destination type (e.g. `operator bool()`). An implicit conversion in the destination type is defined by a converting constructor, which is a constructor that can take the source type as its only argument. Note that a multi-parameter constructor can still be a converting constructor, if all but the first parameter have default values. + +The `explicit` keyword can be applied to a constructor or (since {cpp}11) a conversion operator, to ensure that it can only be used when the destination type is explicit at the point of use, e.g. with a cast. This applies not only to implicit conversions, but to {cpp}11's list initialization syntax: + +-------------------------------- +class Foo { + explicit Foo(int x, double y); + ... +}; + +void Func(Foo f); +-------------------------------- + +--------------------------- +Func({42, 3.14}); // Error +--------------------------- + +This kind of code isn't technically an implicit conversion, but the language treats it as one as far as `explicit` is concerned. + +* Implicit conversions can make a type more usable and expressive by eliminating the need to explicitly name a type when it's obvious. +* Implicit conversions can be a simpler alternative to overloading. +* List initialization syntax is a concise and expressive way of initializing objects. + +* Implicit conversions can hide type-mismatch bugs, where the destination type does not match the user's expectation, or the user is unaware that any conversion will take place. +* Implicit conversions can make code harder to read, particularly in the presence of overloading, by making it less obvious what code is actually getting called. +* Constructors that take a single argument may accidentally be usable as implicit type conversions, even if they are not intended to do so. +* When a single-argument constructor is not marked `explicit`, there's no reliable way to tell whether it's intended to define an implicit conversion, or the author simply forgot to mark it. +* It's not always clear which type should provide the conversion, and if they both do, the code becomes ambiguous. +* List initialization can suffer from the same problems if the destination type is implicit, particularly if the list has only a single element. + +Type conversion operators, and constructors that are callable with a single argument, must be marked `explicit` in the class definition. As an exception, copy and move constructors should not be `explicit`, since they do not perform type conversion. Implicit conversions can sometimes be necessary and appropriate for types that are designed to transparently wrap other types. In that case, contact your project leads to request a waiver of this rule. + +Constructors that cannot be called with a single argument should usually omit `explicit`. Constructors that take a single `std::initializer_list` parameter should also omit `explicit`, in order to support copy-initialization (e.g. `MyType m = {1, 2};`). + +[[Copyable_Movable_Types]] +=== Copyable and Movable Types + +Support copying and/or moving if it makes sense for your type. Otherwise, disable the implicitly generated special functions that perform copies and moves. + +A copyable type allows its objects to be initialized or assigned from any other object of the same type, without changing the value of the source. For user-defined types, the copy behavior is defined by the copy constructor and the copy-assignment operator. `string` is an example of a copyable type. + +A movable type is one that can be initialized and assigned from temporaries (all copyable types are therefore movable). `std::unique_ptr` is an example of a movable but not copyable type. For user-defined types, the move behavior is defined by the move constructor and the move-assignment operator. + +The copy/move constructors can be implicitly invoked by the compiler in some situations, e.g. when passing objects by value. + +Objects of copyable and movable types can be passed and returned by value, which makes APIs simpler, safer, and more general. Unlike when passing pointers or references, there's no risk of confusion over ownership, lifetime, mutability, and similar issues, and no need to specify them in the contract. It also prevents non-local interactions between the client and the implementation, which makes them easier to understand and maintain. Such objects can be used with generic APIs that require pass-by-value, such as most containers. + +Copy/move constructors and assignment operators are usually easier to define correctly than alternatives like `Clone()`, `CopyFrom()` or `Swap()`, because they can be generated by the compiler, either implicitly or with `= default`. They are concise, and ensure that all data members are copied. Copy and move constructors are also generally more efficient, because they don't require heap allocation or separate initialization and assignment steps, and they're eligible for optimizations such as http://en.cppreference.com/w/cpp/language/copy_elision[copy elision]. + +Move operations allow the implicit and efficient transfer of resources out of rvalue objects. This allows a plainer coding style in some cases. + +Many types do not need to be copyable, and providing copy operations for them can be confusing, nonsensical, or outright incorrect. Copy/assigment operations for base class types are hazardous, because use of them can lead to http://en.wikipedia.org/wiki/Object_slicing[object slicing]. Defaulted or carelessly-implemented copy operations can be incorrect, and the resulting bugs can be confusing and difficult to diagnose. + +Copy constructors are invoked implicitly, which makes the invocation easy to miss. This may cause confusion, particularly for programmers used to languages where pass-by-reference is conventional or mandatory. It may also encourage excessive copying, which can cause performance problems. + +Make your type copyable/movable if it will be useful, and if it makes sense in the context of the rest of the API. As a rule of thumb, if the behavior (including computational complexity) of a copy isn't immediately obvious to users of your type, your type shouldn't be copyable. If you define a copy or move constructor, define the corresponding assignment operator, and vice-versa. If your type is copyable, do not define move operations unless they are significantly more efficient than the corresponding copy operations. If your type is not copyable, but the correctness of a move is obvious to users of the type, you may make the type move-only by defining both of the move operations. + +If your type provides copy operations, it is recommended that you design your class so that the default implementation of those operations is correct and that you explicitly define them with `= default`. Remember to review the correctness of any defaulted operations as you would any other code. + +--------------------------------------------- +class Foo { // Copyable and movable type. + public: + Foo(Foo&& other) = default; + Foo(const Foo& other) = default; + Foo& operator=(Foo&& other) = default; + Foo& operator=(const Foo& other) = default; + + private: + string field_; +}; +--------------------------------------------- + +----------------------------------------------------------- +class Foo { + public: + Foo(Foo&& other) : field_(other.field) {} + // Bad, defines only move constructor, but not operator=. + + private: + Field field_; +}; +----------------------------------------------------------- + +Due to the risk of slicing, avoid providing an assignment operator or public copy/move constructor for a class that's intended to be derived from (and avoid deriving from a class with such members). If your base class needs to be copyable, provide a public virtual `Clone()` method, and a protected copy constructor that derived classes can use to implement it. + +If you do not want to support copy/move operations on your type, explicitly disable them using `= delete` or whatever other mechanism your project uses. + +[[Delegating_and_inheriting_constructors]] +=== Delegating and Inheriting Constructors + +Use delegating and inheriting constructors when they reduce code duplication. + +Delegating and inheriting constructors are two different features, both introduced in {cpp}11, for reducing code duplication in constructors. Delegating constructors allow one of a class's constructors to forward work to one of the class's other constructors, using a special variant of the initialization list syntax. For example: + +---------------------------------------- +X::X(const string& name) : name_(name) { + ... +} + +X::X() : X("") {} +---------------------------------------- + +Inheriting constructors allow a derived class to have its base class's constructors available directly, just as with any of the base class's other member functions, instead of having to redeclare them. This is especially useful if the base has multiple constructors. For example: + +---------------------------------------------------------------- +class Base { + public: + Base(); + Base(int n); + Base(const string& s); + ... +}; + +class Derived : public Base { + public: + using Base::Base; // Base's constructors are redeclared here. +}; +---------------------------------------------------------------- + +This is especially useful when `Derived`'s constructors don't have to do anything more than calling `Base`'s constructors. + +Delegating and inheriting constructors reduce verbosity and boilerplate, which can improve readability. + +Delegating constructors are familiar to Java programmers. + +It's possible to approximate the behavior of delegating constructors by using a helper function. + +Inheriting constructors may be confusing if a derived class introduces new member variables, since the base class constructor doesn't know about them. + +Use delegating and inheriting constructors when they reduce boilerplate and improve readability. Be cautious about inheriting constructors when your derived class has new member variables. Inheriting constructors may still be appropriate in that case if you can use in-class member initialization for the derived class's member variables. + +[[Structs_vs._Classes]] +=== Structs vs. Classes + +Use a `struct` only for passive objects that carry data; everything else is a `class`. + +The `struct` and `class` keywords behave almost identically in {cpp}. We add our own semantic meanings to each keyword, so you should use the appropriate keyword for the data-type you're defining. + +`structs` should be used for passive objects that carry data, and may have associated constants, but lack any functionality other than access/setting the data members. The accessing/setting of fields is done by directly accessing the fields rather than through method invocations. Methods should not provide behavior but should only be used to set up the data members, e.g., constructor, destructor, `Initialize()`, `Reset()`, `Validate()`. + +If more functionality is required, a `class` is more appropriate. If in doubt, make it a `class`. + +For consistency with STL, you can use `struct` instead of `class` for functors and traits. + +Note that member variables in structs and classes have link:#Variable_Names[different naming rules]. + +[[Inheritance]] +=== Inheritance + +Composition is often more appropriate than inheritance. When using inheritance, make it `public`. + +When a sub-class inherits from a base class, it includes the definitions of all the data and operations that the parent base class defines. In practice, inheritance is used in two major ways in {cpp}: implementation inheritance, in which actual code is inherited by the child, and link:#Interfaces[interface inheritance], in which only method names are inherited. + +Implementation inheritance reduces code size by re-using the base class code as it specializes an existing type. Because inheritance is a compile-time declaration, you and the compiler can understand the operation and detect errors. Interface inheritance can be used to programmatically enforce that a class expose a particular API. Again, the compiler can detect errors, in this case, when a class does not define a necessary method of the API. + +For implementation inheritance, because the code implementing a sub-class is spread between the base and the sub-class, it can be more difficult to understand an implementation. The sub-class cannot override functions that are not virtual, so the sub-class cannot change implementation. The base class may also define some data members, so that specifies physical layout of the base class. + +All inheritance should be `public`. If you want to do private inheritance, you should be including an instance of the base class as a member instead. + +Do not overuse implementation inheritance. Composition is often more appropriate. Try to restrict use of inheritance to the "is-a" case: `Bar` subclasses `Foo` if it can reasonably be said that `Bar` "is a kind of" `Foo`. + +Make your destructor `virtual` if necessary. If your class has virtual methods, its destructor should be virtual. + +Limit the use of `protected` to those member functions that might need to be accessed from subclasses. Note that link:#Access_Control[data members should be private]. + +Explicitly annotate overrides of virtual functions or virtual destructors with an `override` or (less frequently) `final` specifier. Older (pre-{cpp}11) code will use the `virtual` keyword as an inferior alternative annotation. For clarity, use exactly one of `override`, `final`, or `virtual` when declaring an override. Rationale: A function or destructor marked `override` or `final` that is not an override of a base class virtual function will not compile, and this helps catch common errors. The specifiers serve as documentation; if no specifier is present, the reader has to check all ancestors of the class in question to determine if the function or destructor is virtual or not. + +[[Multiple_Inheritance]] +=== Multiple Inheritance + +Only very rarely is multiple implementation inheritance actually useful. We allow multiple inheritance only when at most one of the base classes has an implementation; all other base classes must be link:#Interfaces[pure interface] classes tagged with the `Interface` suffix. + +Multiple inheritance allows a sub-class to have more than one base class. We distinguish between base classes that are _pure interfaces_ and those that have an __implementation__. + +Multiple implementation inheritance may let you re-use even more code than single inheritance (see link:#Inheritance[Inheritance]). + +Only very rarely is multiple _implementation_ inheritance actually useful. When multiple implementation inheritance seems like the solution, you can usually find a different, more explicit, and cleaner solution. + +Multiple inheritance is allowed only when all superclasses, with the possible exception of the first one, are link:#Interfaces[pure interfaces]. In order to ensure that they remain pure interfaces, they must end with the `Interface` suffix. + +There is an link:#Windows_Code[exception] to this rule on Windows. + +[[Interfaces]] +=== Interfaces + +Classes that satisfy certain conditions are allowed, but not required, to end with an `Interface` suffix. + +A class is a pure interface if it meets the following requirements: + +* It has only public pure virtual ("`= 0`") methods and static methods (but see below for destructor). +* It may not have non-static data members. +* It need not have any constructors defined. If a constructor is provided, it must take no arguments and it must be protected. +* If it is a subclass, it may only be derived from classes that satisfy these conditions and are tagged with the `Interface` suffix. + +An interface class can never be directly instantiated because of the pure virtual method(s) it declares. To make sure all implementations of the interface can be destroyed correctly, the interface must also declare a virtual destructor (in an exception to the first rule, this should not be pure). See Stroustrup, The {cpp} Programming Language, 3rd edition, section 12.4 for details. + +Tagging a class with the `Interface` suffix lets others know that they must not add implemented methods or non static data members. This is particularly important in the case of link:#Multiple_Inheritance[multiple inheritance]. Additionally, the interface concept is already well-understood by Java programmers. + +The `Interface` suffix lengthens the class name, which can make it harder to read and understand. Also, the interface property may be considered an implementation detail that shouldn't be exposed to clients. + +A class may end with `Interface` only if it meets the above requirements. We do not require the converse, however: classes that meet the above requirements are not required to end with `Interface`. + +[[Operator_Overloading]] +=== Operator Overloading + +Overload operators judiciously. Do not create user-defined literals. + +{cpp} permits user code to http://en.cppreference.com/w/cpp/language/operators[declare overloaded versions of the built-in operators] using the `operator` keyword, so long as one of the parameters is a user-defined type. The `operator` keyword also permits user code to define new kinds of literals using `operator""`, and to define type-conversion functions such as `operator bool()`. + +Operator overloading can make code more concise and intuitive by enabling user-defined types to behave the same as built-in types. Overloaded operators are the idiomatic names for certain operations (e.g. `==`, `<`, `=`, and `<<`), and adhering to those conventions can make user-defined types more readable and enable them to interoperate with libraries that expect those names. + +User-defined literals are a very concise notation for creating objects of user-defined types. + +* Providing a correct, consistent, and unsurprising set of operator overloads requires some care, and failure to do so can lead to confusion and bugs. +* Overuse of operators can lead to obfuscated code, particularly if the overloaded operator's semantics don't follow convention. +* The hazards of function overloading apply just as much to operator overloading, if not more so. +* Operator overloads can fool our intuition into thinking that expensive operations are cheap, built-in operations. +* Finding the call sites for overloaded operators may requre a search tool that's aware of {cpp} syntax, rather than e.g. grep. +* If you get the argument type of an overloaded operator wrong, you may get a different overload rather than a compiler error. For example, `foo < bar` may do one thing, while `&foo < &bar` does something totally different. +* Certain operator overloads are inherently hazardous. Overloading unary `&` can cause the same code to have different meanings depending on whether the overload declaration is visible. Overloads of `&&`, `||`, and `,` (comma) cannot match the evaluation-order semantics of the built-in operators. +* Operators are often defined outside the class, so there's a risk of different files introducing different definitions of the same operator. If both definitions are linked into the same binary, this results in undefined behavior, which can manifest as subtle run-time bugs. +* User-defined literals allow the creation of new syntactic forms that are unfamiliar even to experienced {cpp} programmers. + +Define overloaded operators only if their meaning is obvious, unsurprising, and consistent with the corresponding built-in operators. For example, use `|` as a bitwise- or logical-or, not as a shell-style pipe. + +Define operators only on your own types. More precisely, define them in the same headers, .cc files, and namespaces as the types they operate on. That way, the operators are available wherever the type is, minimizing the risk of multiple definitions. If possible, avoid defining operators as templates, because they must satisfy this rule for any possible template arguments. If you define an operator, also define any related operators that make sense, and make sure they are defined consistently. For example, if you overload `<`, overload all the comparison operators, and make sure `<` and `>` never return true for the same arguments. + +Prefer to define non-modifying binary operators as non-member functions. If a binary operator is defined as a class member, implicit conversions will apply to the right-hand argument, but not the left-hand one. It will confuse your users if `a < b` compiles but `b < a` doesn't. + +Don't go out of your way to avoid defining operator overloads. For example, prefer to define `==`, `=`, and `<<`, rather than `Equals()`, `CopyFrom()`, and `PrintTo()`. Conversely, don't define operator overloads just because other libraries expect them. For example, if your type doesn't have a natural ordering, but you want to store it in a `std::set`, use a custom comparator rather than overloading `<`. + +Do not overload `&&`, `||`, `,` (comma), or unary `&`. Do not overload `operator""`, i.e. do not introduce user-defined literals. + +Type conversion operators are covered in the section on link:#Implicit_Conversions[implicit conversions]. The `=` operator is covered in the section on link:#Copy_Constructors[copy constructors]. Overloading `<<` for use with streams is covered in the section on link:#Streams[streams]. See also the rules on link:#Function_Overloading[function overloading], which apply to operator overloading as well. + +[[Access_Control]] +=== Access Control + +Make data members `private`, unless they are `static const` (and follow the link:#Constant_Names[naming convention for constants]). For technical reasons, we allow data members of a test fixture class to be `protected` when using http://code.google.com/p/googletest/[Google Test]). + +[[Declaration_Order]] +=== Declaration Order + +Use the specified order of declarations within a class: `public:` before `private:`, methods before data members (variables), etc. + +Your class definition should start with its `public:` section, followed by its `protected:` section and then its `private:` section. If any of these sections are empty, omit them. + +Within each section, the declarations generally should be in the following order: + +* Typedefs and Enums +* Constants (`static const` data members) +* Constructors +* Destructor +* Methods, including static methods +* Data Members (except `static const` data members) + +If copying and assignment are disabled with a macro such as `DISALLOW_COPY_AND_ASSIGN`, it should be at the end of the `private:` section, and should be the last thing in the class. See link:#Copyable_Movable_Types[Copyable and Movable Types]. + +Do not put large method definitions inline in the class definition. Usually, only trivial or performance-critical, and very short, methods may be defined inline. See link:#Inline_Functions[Inline Functions] for more details. + +[[Functions]] +== Functions + +[[Function_Parameter_Ordering]] +=== Parameter Ordering + +When defining a function, parameter order is: inputs, then outputs. + +Parameters to C/{cpp} functions are either input to the function, output from the function, or both. Input parameters are usually values or `const` references, while output and input/output parameters will be non-`const` pointers. When ordering function parameters, put all input-only parameters before any output parameters. In particular, do not add new parameters to the end of the function just because they are new; place new input-only parameters before the output parameters. + +This is not a hard-and-fast rule. Parameters that are both input and output (often classes/structs) muddy the waters, and, as always, consistency with related functions may require you to bend the rule. + +[[Write_Short_Functions]] +=== Write Short Functions + +Prefer small and focused functions. + +We recognize that long functions are sometimes appropriate, so no hard limit is placed on functions length. If a function exceeds about 40 lines, think about whether it can be broken up without harming the structure of the program. + +Even if your long function works perfectly now, someone modifying it in a few months may add new behavior. This could result in bugs that are hard to find. Keeping your functions short and simple makes it easier for other people to read and modify your code. + +You could find long and complicated functions when working with some code. Do not be intimidated by modifying existing code: if working with such a function proves to be difficult, you find that errors are hard to debug, or you want to use a piece of it in several different contexts, consider breaking up the function into smaller and more manageable pieces. + +[[Reference_Arguments]] +=== Reference Arguments + +All parameters passed by reference must be labeled `const`. + +In C, if a function needs to modify a variable, the parameter must use a pointer, eg `int foo(int *pval)`. In {cpp}, the function can alternatively declare a reference parameter: `int foo(int &val)`. + +Defining a parameter as reference avoids ugly code like `(*pval)++`. Necessary for some applications like copy constructors. Makes it clear, unlike with pointers, that a null pointer is not a possible value. + +References can be confusing, as they have value syntax but pointer semantics. + +Within function parameter lists all references must be `const`: + +---------------------------------------- +void Foo(const string &in, string *out); +---------------------------------------- + +In fact it is a very strong convention in Google code that input arguments are values or `const` references while output arguments are pointers. Input parameters may be `const` pointers, but we never allow non-`const` reference parameters except when required by convention, e.g., `swap()`. + +However, there are some instances where using `const T*` is preferable to `const T&` for input parameters. For example: + +* You want to pass in a null pointer. +* The function saves a pointer or reference to the input. + +Remember that most of the time input parameters are going to be specified as `const T&`. Using `const T*` instead communicates to the reader that the input is somehow treated differently. So if you choose `const T*` rather than `const T&`, do so for a concrete reason; otherwise it will likely confuse readers by making them look for an explanation that doesn't exist. + +[[Function_Overloading]] +=== Function Overloading + +Use overloaded functions (including constructors) only if a reader looking at a call site can get a good idea of what is happening without having to first figure out exactly which overload is being called. + +You may write a function that takes a `const string&` and overload it with another that takes `const char*`. + +------------------------------------------------- +class MyClass { + public: + void Analyze(const string &text); + void Analyze(const char *text, size_t textlen); +}; +------------------------------------------------- + +Overloading can make code more intuitive by allowing an identically-named function to take different arguments. It may be necessary for templatized code, and it can be convenient for Visitors. + +If a function is overloaded by the argument types alone, a reader may have to understand {cpp}'s complex matching rules in order to tell what's going on. Also many people are confused by the semantics of inheritance if a derived class overrides only some of the variants of a function. + +If you want to overload a function, consider qualifying the name with some information about the arguments, e.g., `AppendString()`, `AppendInt()` rather than just `Append()`. If you are overloading a function to support variable number of arguments of the same type, consider making it take a `vector` so that the user can use an link:#Braced_Initializer_List[initializer list] to specify the arguments. + +[[Default_Arguments]] +=== Default Arguments + +We do not allow default function parameters, except in limited situations as explained below. Simulate them with function overloading instead, if appropriate. + +Often you have a function that uses default values, but occasionally you want to override the defaults. Default parameters allow an easy way to do this without having to define many functions for the rare exceptions. Compared to overloading the function, default arguments have a cleaner syntax, with less boilerplate and a clearer distinction between 'required' and 'optional' arguments. + +Function pointers are confusing in the presence of default arguments, since the function signature often doesn't match the call signature. Adding a default argument to an existing function changes its type, which can cause problems with code taking its address. Adding function overloads avoids these problems. In addition, default parameters may result in bulkier code since they are replicated at every call-site -- as opposed to overloaded functions, where "the default" appears only in the function definition. + +While the cons above are not that onerous, they still outweigh the (small) benefits of default arguments over function overloading. So except as described below, we require all arguments to be explicitly specified. + +One specific exception is when the function is a static function (or in an unnamed namespace) in a .cc file. In this case, the cons don't apply since the function's use is so localized. + +In addition, default function parameters are allowed in constructors. Most of the cons listed above don't apply to constructors because it's impossible to take their address. + +Another specific exception is when default arguments are used to simulate variable-length argument lists. + +------------------------------------------------------------ +// Support up to 4 params by using a default empty AlphaNum. +string StrCat(const AlphaNum &a, + const AlphaNum &b = gEmptyAlphaNum, + const AlphaNum &c = gEmptyAlphaNum, + const AlphaNum &d = gEmptyAlphaNum); +------------------------------------------------------------ + +[[trailing_return]] +=== Trailing Return Type Syntax + +Use trailing return types only where using the ordinary syntax (leading return types) is impractical or much less readable. + +{cpp} allows two different forms of function declarations. In the older form, the return type appears before the function name. For example: + +--------------- +int foo(int x); +--------------- + +The new form, introduced in {cpp}11, uses the `auto` keyword before the function name and a trailing return type after the argument list. For example, the declaration above could equivalently be written: + +----------------------- +auto foo(int x) -> int; +----------------------- + +The trailing return type is in the function's scope. This doesn't make a difference for a simple case like `int` but it matters for more complicated cases, like types declared in class scope or types written in terms of the function parameters. + +Trailing return types are the only way to explicitly specify the return type of a link:#Lambda_expressions[lambda expression]. In some cases the compiler is able to deduce a lambda's return type, but not in all cases. Even when the compiler can deduce it automatically, sometimes specifying it explicitly would be clearer for readers. + +Sometimes it's easier and more readable to specify a return type after the function's parameter list has already appeared. This is particularly true when the return type depends on template parameters. For example: + +------------------------------------------------------------------ +template auto add(T t, U u) -> decltype(t + u); +------------------------------------------------------------------ + +versus + +---------------------------------------------------------------------------------- +template decltype(declval() + declval()) add(T t, U u); +---------------------------------------------------------------------------------- + +Trailing return type syntax is relatively new and it has no analogue in {cpp}-like languages like C and Java, so some readers may find it unfamiliar. + +Existing code bases have an enormous number of function declarations that aren't going to get changed to use the new syntax, so the realistic choices are using the old syntax only or using a mixture of the two. Using a single version is better for uniformity of style. + +In most cases, continue to use the older style of function declaration where the return type goes before the function name. Use the new trailing-return-type form only in cases where it's required (such as lambdas) or where, by putting the type after the function's parameter list, it allows you to write the type in a much more readable way. The latter case should be rare; it's mostly an issue in fairly complicated template code, which is link:#Template_metaprogramming[discouraged in most cases]. + +[[Google-Specific_Magic]] +== Google-Specific Magic + +There are various tricks and utilities that we use to make {cpp} code more robust, and various ways we use {cpp} that may differ from what you see elsewhere. + +[[Ownership_and_Smart_Pointers]] +=== Ownership and Smart Pointers + +Prefer to have single, fixed owners for dynamically allocated objects. Prefer to transfer ownership with smart pointers. + +"Ownership" is a bookkeeping technique for managing dynamically allocated memory (and other resources). The owner of a dynamically allocated object is an object or function that is responsible for ensuring that it is deleted when no longer needed. Ownership can sometimes be shared, in which case the last owner is typically responsible for deleting it. Even when ownership is not shared, it can be transferred from one piece of code to another. + +"Smart" pointers are classes that act like pointers, e.g. by overloading the `*` and `->` operators. Some smart pointer types can be used to automate ownership bookkeeping, to ensure these responsibilities are met. http://en.cppreference.com/w/cpp/memory/unique_ptr[`std::unique_ptr`] is a smart pointer type introduced in {cpp}11, which expresses exclusive ownership of a dynamically allocated object; the object is deleted when the `std::unique_ptr` goes out of scope. It cannot be copied, but can be _moved_ to represent ownership transfer. http://en.cppreference.com/w/cpp/memory/shared_ptr[`std::shared_ptr`] is a smart pointer type that expresses shared ownership of a dynamically allocated object. `std::shared_ptr`s can be copied; ownership of the object is shared among all copies, and the object is deleted when the last `std::shared_ptr` is destroyed. + +* It's virtually impossible to manage dynamically allocated memory without some sort of ownership logic. +* Transferring ownership of an object can be cheaper than copying it (if copying it is even possible). +* Transferring ownership can be simpler than 'borrowing' a pointer or reference, because it reduces the need to coordinate the lifetime of the object between the two users. +* Smart pointers can improve readability by making ownership logic explicit, self-documenting, and unambiguous. +* Smart pointers can eliminate manual ownership bookkeeping, simplifying the code and ruling out large classes of errors. +* For const objects, shared ownership can be a simple and efficient alternative to deep copying. + +* Ownership must be represented and transferred via pointers (whether smart or plain). Pointer semantics are more complicated than value semantics, especially in APIs: you have to worry not just about ownership, but also aliasing, lifetime, and mutability, among other issues. +* The performance costs of value semantics are often overestimated, so the performance benefits of ownership transfer might not justify the readability and complexity costs. +* APIs that transfer ownership force their clients into a single memory management model. +* Code using smart pointers is less explicit about where the resource releases take place. +* `std::unique_ptr` expresses ownership transfer using {cpp}11's move semantics, which are relatively new and may confuse some programmers. +* Shared ownership can be a tempting alternative to careful ownership design, obfuscating the design of a system. +* Shared ownership requires explicit bookkeeping at run-time, which can be costly. +* In some cases (e.g. cyclic references), objects with shared ownership may never be deleted. +* Smart pointers are not perfect substitutes for plain pointers. + +If dynamic allocation is necessary, prefer to keep ownership with the code that allocated it. If other code needs access to the object, consider passing it a copy, or passing a pointer or reference without transferring ownership. Prefer to use `std::unique_ptr` to make ownership transfer explicit. For example: + +------------------------------------------- +std::unique_ptr FooFactory(); +void FooConsumer(std::unique_ptr ptr); +------------------------------------------- + +Do not design your code to use shared ownership without a very good reason. One such reason is to avoid expensive copy operations, but you should only do this if the performance benefits are significant, and the underlying object is immutable (i.e. `std::shared_ptr`). If you do use shared ownership, prefer to use `std::shared_ptr`. + +Do not use `scoped_ptr` in new code unless you need to be compatible with older versions of {cpp}. Never use `std::auto_ptr`. Instead, use `std::unique_ptr`. + +[[cpplint]] +=== cpplint + +Use `cpplint.py` to detect style errors. + +`cpplint.py` is a tool that reads a source file and identifies many style errors. It is not perfect, and has both false positives and false negatives, but it is still a valuable tool. False positives can be ignored by putting `// NOLINT` at the end of the line or `// NOLINTNEXTLINE` in the previous line. + +Some projects have instructions on how to run `cpplint.py` from their project tools. If the project you are contributing to does not, you can download http://google-styleguide.googlecode.com/svn/trunk/cpplint/cpplint.py[`cpplint.py`] separately. + +[[Other_{cpp}_Features]] +== Other {cpp} Features + +[[Rvalue_references]] +=== Rvalue References + +Use rvalue references only to define move constructors and move assignment operators, or for perfect forwarding. + +Rvalue references are a type of reference that can only bind to temporary objects. The syntax is similar to traditional reference syntax. For example, `void f(string&& s);` declares a function whose argument is an rvalue reference to a string. + +* Defining a move constructor (a constructor taking an rvalue reference to the class type) makes it possible to move a value instead of copying it. If `v1` is a `vector`, for example, then `auto v2(std::move(v1))` will probably just result in some simple pointer manipulation instead of copying a large amount of data. In some cases this can result in a major performance improvement. +* Rvalue references make it possible to write a generic function wrapper that forwards its arguments to another function, and works whether or not its arguments are temporary objects. (This is sometimes called "perfect forwarding".) +* Rvalue references make it possible to implement types that are movable but not copyable, which can be useful for types that have no sensible definition of copying but where you might still want to pass them as function arguments, put them in containers, etc. +* `std::move` is necessary to make effective use of some standard-library types, such as `std::unique_ptr`. + +* Rvalue references are a relatively new feature (introduced as part of {cpp}11), and not yet widely understood. Rules like reference collapsing, and automatic synthesis of move constructors, are complicated. + +Use rvalue references only to define move constructors and move assignment operators (as described in link:#Copyable_Movable_Types[Copyable and Movable Types]) and, in conjunction with `std::forward`, to support perfect forwarding. You may use `std::move` to express moving a value from one object to another rather than copying it. + +[[Variable-Length_Arrays_and_alloca__]] +=== Variable-Length Arrays and alloca() + +We do not allow variable-length arrays or `alloca()`. + +Variable-length arrays have natural-looking syntax. Both variable-length arrays and `alloca()` are very efficient. + +Variable-length arrays and alloca are not part of Standard {cpp}. More importantly, they allocate a data-dependent amount of stack space that can trigger difficult-to-find memory overwriting bugs: "It ran fine on my machine, but dies mysteriously in production". + +Use a safe allocator instead, such as `vector` or `std::unique_ptr`. + +[[Friends]] +=== Friends + +We allow use of `friend` classes and functions, within reason. + +Friends should usually be defined in the same file so that the reader does not have to look in another file to find uses of the private members of a class. A common use of `friend` is to have a `FooBuilder` class be a friend of `Foo` so that it can construct the inner state of `Foo` correctly, without exposing this state to the world. In some cases it may be useful to make a unittest class a friend of the class it tests. + +Friends extend, but do not break, the encapsulation boundary of a class. In some cases this is better than making a member public when you want to give only one other class access to it. However, most classes should interact with other classes solely through their public members. + +[[Exceptions]] +=== Exceptions + +We do not use {cpp} exceptions. + +* Exceptions allow higher levels of an application to decide how to handle "can't happen" failures in deeply nested functions, without the obscuring and error-prone bookkeeping of error codes. +* Exceptions are used by most other modern languages. Using them in {cpp} would make it more consistent with Python, Java, and the {cpp} that others are familiar with. +* Some third-party {cpp} libraries use exceptions, and turning them off internally makes it harder to integrate with those libraries. +* Exceptions are the only way for a constructor to fail. We can simulate this with a factory function or an `Init()` method, but these require heap allocation or a new "invalid" state, respectively. +* Exceptions are really handy in testing frameworks. + +* When you add a `throw` statement to an existing function, you must examine all of its transitive callers. Either they must make at least the basic exception safety guarantee, or they must never catch the exception and be happy with the program terminating as a result. For instance, if `f()` calls `g()` calls `h()`, and `h` throws an exception that `f` catches, `g` has to be careful or it may not clean up properly. +* More generally, exceptions make the control flow of programs difficult to evaluate by looking at code: functions may return in places you don't expect. This causes maintainability and debugging difficulties. You can minimize this cost via some rules on how and where exceptions can be used, but at the cost of more that a developer needs to know and understand. +* Exception safety requires both RAII and different coding practices. Lots of supporting machinery is needed to make writing correct exception-safe code easy. Further, to avoid requiring readers to understand the entire call graph, exception-safe code must isolate logic that writes to persistent state into a "commit" phase. This will have both benefits and costs (perhaps where you're forced to obfuscate code to isolate the commit). Allowing exceptions would force us to always pay those costs even when they're not worth it. +* Turning on exceptions adds data to each binary produced, increasing compile time (probably slightly) and possibly increasing address space pressure. +* The availability of exceptions may encourage developers to throw them when they are not appropriate or recover from them when it's not safe to do so. For example, invalid user input should not cause exceptions to be thrown. We would need to make the style guide even longer to document these restrictions! + +On their face, the benefits of using exceptions outweigh the costs, especially in new projects. However, for existing code, the introduction of exceptions has implications on all dependent code. If exceptions can be propagated beyond a new project, it also becomes problematic to integrate the new project into existing exception-free code. Because most existing {cpp} code at Google is not prepared to deal with exceptions, it is comparatively difficult to adopt new code that generates exceptions. + +Given that Google's existing code is not exception-tolerant, the costs of using exceptions are somewhat greater than the costs in a new project. The conversion process would be slow and error-prone. We don't believe that the available alternatives to exceptions, such as error codes and assertions, introduce a significant burden. + +Our advice against using exceptions is not predicated on philosophical or moral grounds, but practical ones. Because we'd like to use our open-source projects at Google and it's difficult to do so if those projects use exceptions, we need to advise against exceptions in Google open-source projects as well. Things would probably be different if we had to do it all over again from scratch. + +This prohibition also applies to the exception-related features added in {cpp}11, such as `noexcept`, `std::exception_ptr`, and `std::nested_exception`. + +There is an link:#Windows_Code[exception] to this rule (no pun intended) for Windows code. + +[[Run-Time_Type_Information__RTTI_]] +=== Run-Time Type Information (RTTI) + +Avoid using Run Time Type Information (RTTI). + +RTTI allows a programmer to query the {cpp} class of an object at run time. This is done by use of `typeid` or `dynamic_cast`. + +Querying the type of an object at run-time frequently means a design problem. Needing to know the type of an object at runtime is often an indication that the design of your class hierarchy is flawed. + +Undisciplined use of RTTI makes code hard to maintain. It can lead to type-based decision trees or switch statements scattered throughout the code, all of which must be examined when making further changes. + +The standard alternatives to RTTI (described below) require modification or redesign of the class hierarchy in question. Sometimes such modifications are infeasible or undesirable, particularly in widely-used or mature code. + +RTTI can be useful in some unit tests. For example, it is useful in tests of factory classes where the test has to verify that a newly created object has the expected dynamic type. It is also useful in managing the relationship between objects and their mocks. + +RTTI is useful when considering multiple abstract objects. Consider + +------------------------------------------------ +bool Base::Equal(Base* other) = 0; +bool Derived::Equal(Base* other) { + Derived* that = dynamic_cast(other); + if (that == NULL) + return false; + ... +} +------------------------------------------------ + +RTTI has legitimate uses but is prone to abuse, so you must be careful when using it. You may use it freely in unittests, but avoid it when possible in other code. In particular, think twice before using RTTI in new code. If you find yourself needing to write code that behaves differently based on the class of an object, consider one of the following alternatives to querying the type: + +* Virtual methods are the preferred way of executing different code paths depending on a specific subclass type. This puts the work within the object itself. +* If the work belongs outside the object and instead in some processing code, consider a double-dispatch solution, such as the Visitor design pattern. This allows a facility outside the object itself to determine the type of class using the built-in type system. + +When the logic of a program guarantees that a given instance of a base class is in fact an instance of a particular derived class, then a `dynamic_cast` may be used freely on the object. Usually one can use a `static_cast` as an alternative in such situations. + +Decision trees based on type are a strong indication that your code is on the wrong track. + +----------------------------------------- +if (typeid(*data) == typeid(D1)) { + ... +} else if (typeid(*data) == typeid(D2)) { + ... +} else if (typeid(*data) == typeid(D3)) { +... +----------------------------------------- + +Code such as this usually breaks when additional subclasses are added to the class hierarchy. Moreover, when properties of a subclass change, it is difficult to find and modify all the affected code segments. + +Do not hand-implement an RTTI-like workaround. The arguments against RTTI apply just as much to workarounds like class hierarchies with type tags. Moreover, workarounds disguise your true intent. + +[[Casting]] +=== Casting + +Use {cpp} casts like `static_cast<>()`. Do not use other cast formats like `int y = (int)x;` or `int y = int(x);`. + +{cpp} introduced a different cast system from C that distinguishes the types of cast operations. + +The problem with C casts is the ambiguity of the operation; sometimes you are doing a _conversion_ (e.g., `(int)3.5`) and sometimes you are doing a _cast_ (e.g., `(int)"hello"`); {cpp} casts avoid this. Additionally {cpp} casts are more visible when searching for them. + +The syntax is nasty. + +Do not use C-style casts. Instead, use these {cpp}-style casts. + +* Use `static_cast` as the equivalent of a C-style cast that does value conversion, or when you need to explicitly up-cast a pointer from a class to its superclass. +* Use `const_cast` to remove the `const` qualifier (see link:#Use_of_const[const]). +* Use `reinterpret_cast` to do unsafe conversions of pointer types to and from integer and other pointer types. Use this only if you know what you are doing and you understand the aliasing issues. + +See the link:#Run-Time_Type_Information__RTTI_[RTTI section] for guidance on the use of `dynamic_cast`. + +[[Streams]] +=== Streams + +Use streams where appropriate, and stick to "simple" usages. + +Streams are the standard I/O abstraction in {cpp}, as exemplified by the standard header ``. They are widely used in Google code, but only for debug logging and test diagnostics. + +The `<<` and `>>` stream operators provide an API for formatted I/O that is easily learned, portable, reusable, and extensible. `printf`, by contrast, doesn't even support `string`, to say nothing of user-defined types, and is very difficult to use portably. `printf` also obliges you to choose among the numerous slightly different versions of that function, and navigate the dozens of conversion specifiers. + +Streams provide first-class support for console I/O via `std::cin`, `std::cout`, `std::cerr`, and `std::clog`. The C APIs do as well, but are hampered by the need to manually buffer the input. + +* Stream formatting can be configured by mutating the state of the stream. Such mutations are persistent, so the behavior of your code can be affected by the entire previous history of the stream, unless you go out of your way to restore it to a known state every time other code might have touched it. User code can not only modify the built-in state, it can add new state variables and behaviors through a registration system. +* It is difficult to precisely control stream output, due to the above issues, the way code and data are mixed in streaming code, and the use of operator overloading (which may select a different overload than you expect). +* The practice of building up output through chains of `<<` operators interferes with internationalization, because it bakes word order into the code, and streams' support for localization is http://www.boost.org/doc/libs/1_48_0/libs/locale/doc/html/rationale.html#rationale_why[flawed]. +* The streams API is subtle and complex, so programmers must develop experience with it in order to use it effectively. However, streams were historically banned in Google code (except for logging and diagnostics), so Google engineers tend not to have that experience. Consequently, streams-based code is likely to be less readable and maintainable by Googlers than code based on more familiar abstractions. +* Resolving the many overloads of `<<` is extremely costly for the compiler. When used pervasively in a large code base, it can consume as much as 20% of the parsing and semantic analysis time. + +Use streams only when they are the best tool for the job. This is typically the case when the I/O is ad-hoc, local, human-readable, and targeted at other developers rather than end-users. Be consistent with the code around you, and with the codebase as a whole; if there's an established tool for your problem, use that tool instead. + +Avoid using streams for I/O that faces external users or handles untrusted data. Instead, find and use the appropriate templating libraries to handle issues like internationalization, localization, and security hardening. + +If you do use streams, avoid the stateful parts of the streams API (other than error state), such as `imbue()`, `xalloc()`, and `register_callback()`. Use explicit formatting functions rather than stream manipulators or formatting flags to control formatting details such as number base, precision, or padding. + +Overload `<<` as a streaming operator for your type only if your type represents a value, and `<<` writes out a human-readable string representation of that value. Avoid exposing implementation details in the output of `<<`; if you need to print object internals for debugging, use named functions instead (a method named `DebugString()` is the most common convention). + +[[Preincrement_and_Predecrement]] +=== Preincrement and Predecrement + +Use prefix form (`++i`) of the increment and decrement operators with iterators and other template objects. + +When a variable is incremented (`++i` or `i++`) or decremented (`--i` or `i--`) and the value of the expression is not used, one must decide whether to preincrement (decrement) or postincrement (decrement). + +When the return value is ignored, the "pre" form (`++i`) is never less efficient than the "post" form (`i++`), and is often more efficient. This is because post-increment (or decrement) requires a copy of `i` to be made, which is the value of the expression. If `i` is an iterator or other non-scalar type, copying `i` could be expensive. Since the two types of increment behave the same when the value is ignored, why not just always pre-increment? + +The tradition developed, in C, of using post-increment when the expression value is not used, especially in `for` loops. Some find post-increment easier to read, since the "subject" (`i`) precedes the "verb" (`++`), just like in English. + +For simple scalar (non-object) values there is no reason to prefer one form and we allow either. For iterators and other template types, use pre-increment. + +[[Use_of_const]] +=== Use of const + +Use `const` whenever it makes sense. With {cpp}11, `constexpr` is a better choice for some uses of const. + +Declared variables and parameters can be preceded by the keyword `const` to indicate the variables are not changed (e.g., `const int foo`). Class functions can have the `const` qualifier to indicate the function does not change the state of the class member variables (e.g., `class Foo { int Bar(char c) const; };`). + +Easier for people to understand how variables are being used. Allows the compiler to do better type checking, and, conceivably, generate better code. Helps people convince themselves of program correctness because they know the functions they call are limited in how they can modify your variables. Helps people know what functions are safe to use without locks in multi-threaded programs. + +`const` is viral: if you pass a `const` variable to a function, that function must have `const` in its prototype (or the variable will need a `const_cast`). This can be a particular problem when calling library functions. + +`const` variables, data members, methods and arguments add a level of compile-time type checking; it is better to detect errors as soon as possible. Therefore we strongly recommend that you use `const` whenever it makes sense to do so: + +* If a function does not modify an argument passed by reference or by pointer, that argument should be `const`. +* Declare methods to be `const` whenever possible. Accessors should almost always be `const`. Other methods should be const if they do not modify any data members, do not call any non-`const` methods, and do not return a non-`const` pointer or non-`const` reference to a data member. +* Consider making data members `const` whenever they do not need to be modified after construction. + +The `mutable` keyword is allowed but is unsafe when used with threads, so thread safety should be carefully considered first. + +==== Where to put the const + +Some people favor the form `int const *foo` to `const int* foo`. They argue that this is more readable because it's more consistent: it keeps the rule that `const` always follows the object it's describing. However, this consistency argument doesn't apply in codebases with few deeply-nested pointer expressions since most `const` expressions have only one `const`, and it applies to the underlying value. In such cases, there's no consistency to maintain. Putting the `const` first is arguably more readable, since it follows English in putting the "adjective" (`const`) before the "noun" (`int`). + +That said, while we encourage putting `const` first, we do not require it. But be consistent with the code around you! + +[[Use_of_constexpr]] +=== Use of constexpr + +In {cpp}11, use `constexpr` to define true constants or to ensure constant initialization. + +Some variables can be declared `constexpr` to indicate the variables are true constants, i.e. fixed at compilation/link time. Some functions and constructors can be declared `constexpr` which enables them to be used in defining a `constexpr` variable. + +Use of `constexpr` enables definition of constants with floating-point expressions rather than just literals; definition of constants of user-defined types; and definition of constants with function calls. + +Prematurely marking something as constexpr may cause migration problems if later on it has to be downgraded. Current restrictions on what is allowed in constexpr functions and constructors may invite obscure workarounds in these definitions. + +`constexpr` definitions enable a more robust specification of the constant parts of an interface. Use `constexpr` to specify true constants and the functions that support their definitions. Avoid complexifying function definitions to enable their use with `constexpr`. Do not use `constexpr` to force inlining. + +[[Integer_Types]] +=== Integer Types + +Of the built-in {cpp} integer types, the only one used is `int`. If a program needs a variable of a different size, use a precise-width integer type from ``, such as `int16_t`. If your variable represents a value that could ever be greater than or equal to 2^31 (2GiB), use a 64-bit type such as `int64_t`. Keep in mind that even if your value won't ever be too large for an `int`, it may be used in intermediate calculations which may require a larger type. When in doubt, choose a larger type. + +{cpp} does not specify the sizes of its integer types. Typically people assume that `short` is 16 bits, `int` is 32 bits, `long` is 32 bits and `long long` is 64 bits. + +Uniformity of declaration. + +The sizes of integral types in {cpp} can vary based on compiler and architecture. + +`` defines types like `int16_t`, `uint32_t`, `int64_t`, etc. You should always use those in preference to `short`, `unsigned long long` and the like, when you need a guarantee on the size of an integer. Of the C integer types, only `int` should be used. When appropriate, you are welcome to use standard types like `size_t` and `ptrdiff_t`. + +We use `int` very often, for integers we know are not going to be too big, e.g., loop counters. Use plain old `int` for such things. You should assume that an `int` is at least 32 bits, but don't assume that it has more than 32 bits. If you need a 64-bit integer type, use `int64_t` or `uint64_t`. + +For integers we know can be "big", use `int64_t`. + +You should not use the unsigned integer types such as `uint32_t`, unless there is a valid reason such as representing a bit pattern rather than a number, or you need defined overflow modulo 2^N. In particular, do not use unsigned types to say a number will never be negative. Instead, use assertions for this. + +If your code is a container that returns a size, be sure to use a type that will accommodate any possible usage of your container. When in doubt, use a larger type rather than a smaller type. + +Use care when converting integer types. Integer conversions and promotions can cause non-intuitive behavior. + +==== On Unsigned Integers + +Some people, including some textbook authors, recommend using unsigned types to represent numbers that are never negative. This is intended as a form of self-documentation. However, in C, the advantages of such documentation are outweighed by the real bugs it can introduce. Consider: + +------------------------------------------------------ +for (unsigned int i = foo.Length()-1; i >= 0; --i) ... +------------------------------------------------------ + +This code will never terminate! Sometimes gcc will notice this bug and warn you, but often it will not. Equally bad bugs can occur when comparing signed and unsigned variables. Basically, C's type-promotion scheme causes unsigned types to behave differently than one might expect. + +So, document that a variable is non-negative using assertions. Don't use an unsigned type. + +[[64-bit_Portability]] +=== 64-bit Portability + +Code should be 64-bit and 32-bit friendly. Bear in mind problems of printing, comparisons, and structure alignment. + +* `printf()` specifiers for some types are not cleanly portable between 32-bit and 64-bit systems. C99 defines some portable format specifiers. Unfortunately, MSVC 7.1 does not understand some of these specifiers and the standard is missing a few, so we have to define our own ugly versions in some cases (in the style of the standard include file `inttypes.h`): ++ +------------------------------------------------------- +// printf macros for size_t, in the style of inttypes.h +#ifdef _LP64 +#define __PRIS_PREFIX "z" +#else +#define __PRIS_PREFIX +#endif + +// Use these macros after a % in a printf format string +// to get correct 32/64 bit behavior, like this: +// size_t size = records.size(); +// printf("%" PRIuS "\n", size); + +#define PRIdS __PRIS_PREFIX "d" +#define PRIxS __PRIS_PREFIX "x" +#define PRIuS __PRIS_PREFIX "u" +#define PRIXS __PRIS_PREFIX "X" +#define PRIoS __PRIS_PREFIX "o" + +------------------------------------------------------- ++ +[width="100%",cols="25%,25%,25%,25%",options="header",] +|================================================================= +|Type |DO NOT use |DO use |Notes +|`void *` (or any pointer) |`%lx` |`%p` | +|`int64_t` |`%qd`, `%lld` |`%" PRId64 "` | +|`uint64_t` |`%qu`, `%llu`, `%llx` |`%" PRIu64 "`, `%" PRIx64 "` | +|`size_t` |`%u` |`%" PRIuS "`, `%" PRIxS "` |C99 specifies `%zu` +|`ptrdiff_t` |`%d` |`%" PRIdS "` |C99 specifies `%td` +|================================================================= ++ +Note that the `PRI*` macros expand to independent strings which are concatenated by the compiler. Hence if you are using a non-constant format string, you need to insert the value of the macro into the format, rather than the name. Note also that spaces are required around the macro identifier to separate it from the string literal. It is still possible, as usual, to include length specifiers, etc., after the `%` when using the `PRI*` macros. So, e.g. `printf("x = %30" PRIuS "\n", x)` would expand on 32-bit Linux to `printf("x = %30" "u" "\n", x)`, which the compiler will treat as `printf("x = %30u\n", x)`. +* Remember that `sizeof(void *)` != `sizeof(int)`. Use `intptr_t` if you want a pointer-sized integer. +* You may need to be careful with structure alignments, particularly for structures being stored on disk. Any class/structure with a `int64_t`/`uint64_t` member will by default end up being 8-byte aligned on a 64-bit system. If you have such structures being shared on disk between 32-bit and 64-bit code, you will need to ensure that they are packed the same on both architectures. Most compilers offer a way to alter structure alignment. For gcc, you can use `__attribute__((packed))`. MSVC offers `#pragma pack()` and `__declspec(align())`. +* Use the `LL` or `ULL` suffixes as needed to create 64-bit constants. For example: ++ +--------------------------------- +int64_t my_value = 0x123456789LL; +uint64_t my_mask = 3ULL << 48; +--------------------------------- + +[[Preprocessor_Macros]] +=== Preprocessor Macros + +Be very cautious with macros. Prefer inline functions, enums, and `const` variables to macros. + +Macros mean that the code you see is not the same as the code the compiler sees. This can introduce unexpected behavior, especially since macros have global scope. + +Luckily, macros are not nearly as necessary in {cpp} as they are in C. Instead of using a macro to inline performance-critical code, use an inline function. Instead of using a macro to store a constant, use a `const` variable. Instead of using a macro to "abbreviate" a long variable name, use a reference. Instead of using a macro to conditionally compile code ... well, don't do that at all (except, of course, for the `#define` guards to prevent double inclusion of header files). It makes testing much more difficult. + +Macros can do things these other techniques cannot, and you do see them in the codebase, especially in the lower-level libraries. And some of their special features (like stringifying, concatenation, and so forth) are not available through the language proper. But before using a macro, consider carefully whether there's a non-macro way to achieve the same result. + +The following usage pattern will avoid many problems with macros; if you use macros, follow it whenever possible: + +* Don't define macros in a `.h` file. +* `#define` macros right before you use them, and `#undef` them right after. +* Do not just `#undef` an existing macro before replacing it with your own; instead, pick a name that's likely to be unique. +* Try not to use macros that expand to unbalanced {cpp} constructs, or at least document that behavior well. +* Prefer not using `##` to generate function/class/variable names. + +[[0_and_nullptr/NULL]] +=== 0 and nullptr/NULL + +Use `0` for integers, `0.0` for reals, `nullptr` (or `NULL`) for pointers, and `'\0'` for chars. + +Use `0` for integers and `0.0` for reals. This is not controversial. + +For pointers (address values), there is a choice between `0`, `NULL`, and `nullptr`. For projects that allow {cpp}11 features, use `nullptr`. For {cpp}03 projects, we prefer `NULL` because it looks like a pointer. In fact, some {cpp} compilers provide special definitions of `NULL` which enable them to give useful warnings, particularly in situations where `sizeof(NULL)` is not equal to `sizeof(0)`. + +Use `'\0'` for chars. This is the correct type and also makes code more readable. + +[[sizeof]] +=== sizeof + +Prefer `sizeof(varname)` to `sizeof(type)`. + +Use `sizeof(varname)` when you take the size of a particular variable. `sizeof(varname)` will update appropriately if someone changes the variable type either now or later. You may use `sizeof(type)` for code unrelated to any particular variable, such as code that manages an external or internal data format where a variable of an appropriate {cpp} type is not convenient. + +------------------------------- +Struct data; +memset(&data, 0, sizeof(data)); +------------------------------- + +--------------------------------- +memset(&data, 0, sizeof(Struct)); +--------------------------------- + +--------------------------------------------------------------------------- +if (raw_size < sizeof(int)) { + LOG(ERROR) << "compressed record not big enough for count: " << raw_size; + return false; +} +--------------------------------------------------------------------------- + +[[auto]] +=== auto + +Use `auto` to avoid type names that are just clutter. Continue to use manifest type declarations when it helps readability, and never use `auto` for anything but local variables. + +In {cpp}11, a variable whose type is given as `auto` will be given a type that matches that of the expression used to initialize it. You can use `auto` either to initialize a variable by copying, or to bind a reference. + +----------------------------------------------------- +vector v; +... +auto s1 = v[0]; // Makes a copy of v[0]. +const auto& s2 = v[0]; // s2 is a reference to v[0]. +----------------------------------------------------- + +The `auto` keyword is also used in an unrelated {cpp}11 feature: it's part of the syntax for a new kind of function declaration with a link:#trailing_return[trailing return type]. + +{cpp} type names can sometimes be long and cumbersome, especially when they involve templates or namespaces. In a statement like: + +---------------------------------------------------------- +sparse_hash_map::iterator iter = m.find(val); +---------------------------------------------------------- + +the return type is hard to read, and obscures the primary purpose of the statement. Changing it to: + +------------------------ +auto iter = m.find(val); +------------------------ + +makes it more readable. + +Without `auto` we are sometimes forced to write a type name twice in the same expression, adding no value for the reader, as in: + +----------------------------------------------------------------------- +diagnostics::ErrorStatus* status = new diagnostics::ErrorStatus("xyz"); +----------------------------------------------------------------------- + +Using `auto` makes it easier to use intermediate variables when appropriate, by reducing the burden of writing their types explicitly. + +Sometimes code is clearer when types are manifest, especially when a variable's initialization depends on things that were declared far away. In an expression like: + +----------------------- +auto i = x.Lookup(key); +----------------------- + +it may not be obvious what `i`'s type is, if `x` was declared hundreds of lines earlier. + +Programmers have to understand the difference between `auto` and `const auto&` or they'll get copies when they didn't mean to. + +The interaction between `auto` and {cpp}11 brace-initialization can be confusing. The exact rules have been in flux, and compilers don't all implement the final rules yet. The declarations: + +------------- +auto x{3}; +auto y = {3}; +------------- + +mean different things — `x` is an `int`, while `y` is a `std::initializer_list`. The same applies to other normally-invisible proxy types. + +If an `auto` variable is used as part of an interface, e.g. as a constant in a header, then a programmer might change its type while only intending to change its value, leading to a more radical API change than intended. + +`auto` is permitted, for local variables only. Do not use `auto` for file-scope or namespace-scope variables, or for class members. Never initialize an `auto`-typed variable with a braced initializer list. + +[[Braced_Initializer_List]] +=== Braced Initializer List + +You may use braced initializer lists. + +In {cpp}03, aggregate types (arrays and structs with no constructor) could be initialized with braced initializer lists. + +------------------------------- +struct Point { int x; int y; }; +Point p = {1, 2}; +------------------------------- + +In {cpp}11, this syntax was generalized, and any object type can now be created with a braced initializer list, known as a _braced-init-list_ in the {cpp} grammar. Here are a few examples of its use. + +------------------------------------------------------------------- +// Vector takes a braced-init-list of elements. +vector v{"foo", "bar"}; + +// Basically the same, ignoring some small technicalities. +// You may choose to use either form. +vector v = {"foo", "bar"}; + +// Usable with 'new' expressions. +auto p = new vector{"foo", "bar"}; + +// A map can take a list of pairs. Nested braced-init-lists work. +map m = {{1, "one"}, {2, "2"}}; + +// A braced-init-list can be implicitly converted to a return type. +vector test_function() { return {1, 2, 3}; } + +// Iterate over a braced-init-list. +for (int i : {-1, -2, -3}) {} + +// Call a function using a braced-init-list. +void TestFunction2(vector v) {} +TestFunction2({1, 2, 3}); +------------------------------------------------------------------- + +A user-defined type can also define a constructor and/or assignment operator that take `std::initializer_list`, which is automatically created from __braced-init-list__: + +--------------------------------------------------------------- +class MyType { + public: + // std::initializer_list references the underlying init list. + // It should be passed by value. + MyType(std::initializer_list init_list) { + for (int i : init_list) append(i); + } + MyType& operator=(std::initializer_list init_list) { + clear(); + for (int i : init_list) append(i); + } +}; +MyType m{2, 3, 5, 7}; +--------------------------------------------------------------- + +Finally, brace initialization can also call ordinary constructors of data types, even if they do not have `std::initializer_list` constructors. + +----------------------------------------------------------------- +double d{1.23}; +// Calls ordinary constructor as long as MyOtherType has no +// std::initializer_list constructor. +class MyOtherType { + public: + explicit MyOtherType(string); + MyOtherType(int, string); +}; +MyOtherType m = {1, "b"}; +// If the constructor is explicit, you can't use the "= {}" form. +MyOtherType m{"b"}; +----------------------------------------------------------------- + +Never assign a _braced-init-list_ to an auto local variable. In the single element case, what this means can be confusing. + +--------------------------------------------------------------- +auto d = {1.23}; // d is a std::initializer_list +--------------------------------------------------------------- + +------------------------------------------------------------------------------ +auto d = double{1.23}; // Good -- d is a double, not a std::initializer_list. +------------------------------------------------------------------------------ + +See link:#Braced_Initializer_List_Format[Braced_Initializer_List_Format] for formatting. + +[[Lambda_expressions]] +=== Lambda expressions + +Use lambda expressions where appropriate. Avoid default lambda captures when capturing `this` or if the lambda will escape the current scope. + +Lambda expressions are a concise way of creating anonymous function objects. They're often useful when passing functions as arguments. For example: + +------------------------------------------------ +std::sort(v.begin(), v.end(), [](int x, int y) { + return Weight(x) < Weight(y); +}); +------------------------------------------------ + +They further allow capturing variables from the enclosing scope either explicitly by name, or implicitly using a default capture. Default captures implicitly capture any variable referenced in the lambda body, including `this` if any members are used. The default capture must come first and be one of `&` for capture by reference or `=` for capture by value, followed by any explicit captures which differ from the default: + +------------------------------------------------------------------ +int weight = 3; +int sum = 0; +// Captures `weight` (implicitly) by value and `sum` by reference. +std::for_each(v.begin(), v.end(), [=, &sum](int x) { + sum += weight * x; +}); +------------------------------------------------------------------ + +Lambdas were introduced in {cpp}11 along with a set of utilities for working with function objects, such as the polymorphic wrapper `std::function`. + +* Lambdas are much more concise than other ways of defining function objects to be passed to STL algorithms, which can be a readability improvement. +* Appropriate use of default captures can remove redundancy and highlight important exceptions from the default. +* Lambdas, `std::function`, and `std::bind` can be used in combination as a general purpose callback mechanism; they make it easy to write functions that take bound functions as arguments. + +* Default captures make it easy to overlook an implicit capture and use of `this`. +* Variable capture in lambdas can be tricky, and might be a new source of dangling-pointer bugs, particularly if a lambda escapes the current scope. +* It's possible for use of lambdas to get out of hand; very long nested anonymous functions can make code harder to understand. + +* Use lambda expressions where appropriate, with formatting as described link:#Formatting_Lambda_Expressions[below]. +* Use default captures judiciously, when it aids readability. In particular, prefer to write lambda captures explicitly when capturing `this` or if the lambda will escape the current scope. For example, instead of: ++ +------------------------------------------------------------------------ +{ + Foo foo; + ... + executor->Schedule([&] { Frobnicate(foo); }) + ... +} +// BAD! `Frobnicate` may be a member function and `foo` may be destroyed +// by the time the lambda runs. +------------------------------------------------------------------------ ++ +prefer to write: ++ +------------------------------------------------------------------ +{ + Foo foo; + ... + executor->Schedule([&foo] { Frobnicate(foo); }) + ... +} +// GOOD - The lambda cannot accidentally capture `this` and +// the explicit by-reference capture is more obvious and therefore +// more likely to be checked for correctness. +------------------------------------------------------------------ +* Keep unnamed lambdas short. If a lambda body is more than maybe five lines long, prefer to give the lambda a name, or to use a named function instead of a lambda. +* Specify the return type of the lambda explicitly if that will make it more obvious to readers, as with link:#auto[`auto`]. + +[[Template_metaprogramming]] +=== Template metaprogramming + +Avoid complicated template programming. + +Template metaprogramming refers to a family of techniques that exploit the fact that the {cpp} template instantiation mechanism is Turing complete and can be used to perform arbitrary compile-time computation in the type domain. + +Template metaprogramming allows extremely flexible interfaces that are type safe and high performance. Facilities like https://code.google.com/p/googletest/[Google Test], `std::tuple`, `std::function`, and Boost.Spirit would be impossible without it. + +The techniques used in template metaprogramming are often obscure to anyone but language experts. Code that uses templates in complicated ways is often unreadable, and is hard to debug or maintain. + +Template metaprogramming often leads to extremely poor compiler time error messages: even if an interface is simple, the complicated implementation details become visible when the user does something wrong. + +Template metaprogramming interferes with large scale refactoring by making the job of refactoring tools harder. First, the template code is expanded in multiple contexts, and it's hard to verify that the transformation makes sense in all of them. Second, some refactoring tools work with an AST that only represents the structure of the code after template expansion. It can be difficult to automatically work back to the original source construct that needs to be rewritten. + +Template metaprogramming sometimes allows cleaner and easier-to-use interfaces than would be possible without it, but it's also often a temptation to be overly clever. It's best used in a small number of low level components where the extra maintenance burden is spread out over a large number of uses. + +Think twice before using template metaprogramming or other complicated template techniques; think about whether the average member of your team will be able to understand your code well enough to maintain it after you switch to another project, or whether a non-{cpp} programmer or someone casually browsing the code base will be able to understand the error messages or trace the flow of a function they want to call. If you're using recursive template instantiations or type lists or metafunctions or expression templates, or relying on SFINAE or on the `sizeof` trick for detecting function overload resolution, then there's a good chance you've gone too far. + +If you use template metaprogramming, you should expect to put considerable effort into minimizing and isolating the complexity. You should hide metaprogramming as an implementation detail whenever possible, so that user-facing headers are readable, and you should make sure that tricky code is especially well commented. You should carefully document how the code is used, and you should say something about what the "generated" code looks like. Pay extra attention to the error messages that the compiler emits when users make mistakes. The error messages are part of your user interface, and your code should be tweaked as necessary so that the error messages are understandable and actionable from a user point of view. + +[[Boost]] +=== Boost + +Use only approved libraries from the Boost library collection. + +The http://www.boost.org/[Boost library collection] is a popular collection of peer-reviewed, free, open-source {cpp} libraries. + +Boost code is generally very high-quality, is widely portable, and fills many important gaps in the {cpp} standard library, such as type traits and better binders. + +Some Boost libraries encourage coding practices which can hamper readability, such as metaprogramming and other advanced template techniques, and an excessively "functional" style of programming. + +In order to maintain a high level of readability for all contributors who might read and maintain code, we only allow an approved subset of Boost features. Currently, the following libraries are permitted: + +* http://www.boost.org/libs/utility/call_traits.htm[Call Traits] from `boost/call_traits.hpp` +* http://www.boost.org/libs/utility/compressed_pair.htm[Compressed Pair] from `boost/compressed_pair.hpp` +* http://www.boost.org/libs/graph/[The Boost Graph Library (BGL)] from `boost/graph`, except serialization (`adj_list_serialize.hpp`) and parallel/distributed algorithms and data structures (`boost/graph/parallel/*` and `boost/graph/distributed/*`). +* http://www.boost.org/libs/property_map/[Property Map] from `boost/property_map`, except parallel/distributed property maps (`boost/property_map/parallel/*`). +* http://www.boost.org/libs/iterator/[Iterator] from `boost/iterator` +* The part of http://www.boost.org/libs/polygon/[Polygon] that deals with Voronoi diagram construction and doesn't depend on the rest of Polygon: `boost/polygon/voronoi_builder.hpp`, `boost/polygon/voronoi_diagram.hpp`, and `boost/polygon/voronoi_geometry_type.hpp` +* http://www.boost.org/libs/bimap/[Bimap] from `boost/bimap` +* http://www.boost.org/libs/math/doc/html/dist.html[Statistical Distributions and Functions] from `boost/math/distributions` +* http://www.boost.org/libs/multi_index/[Multi-index] from `boost/multi_index` +* http://www.boost.org/libs/heap/[Heap] from `boost/heap` +* The flat containers from http://www.boost.org/libs/container/[Container]: `boost/container/flat_map`, and `boost/container/flat_set` +* http://www.boost.org/libs/intrusive/[Intrusive] from `boost/intrusive`. + +We are actively considering adding other Boost features to the list, so this list may be expanded in the future. + +The following libraries are permitted, but their use is discouraged because they've been superseded by standard libraries in {cpp}11: + +* http://www.boost.org/libs/array/[Array] from `boost/array.hpp`: use http://en.cppreference.com/w/cpp/container/array[`std::array`] instead. +* http://www.boost.org/libs/ptr_container/[Pointer Container] from `boost/ptr_container`: use containers of http://en.cppreference.com/w/cpp/memory/unique_ptr[`std::unique_ptr`] instead. + +[[std_hash]] +=== std::hash + +Do not define specializations of `std::hash`. + +`std::hash` is the function object that the {cpp}11 hash containers use to hash keys of type `T`, unless the user explicitly specifies a different hash function. For example, `std::unordered_map` is a hash map that uses `std::hash` to hash its keys, whereas `std::unordered_map` uses `MyIntHash`. + +`std::hash` is defined for all integral, floating-point, pointer, and `enum` types, as well as some standard library types such as `string` and `unique_ptr`. Users can enable it to work for their own types by defining specializations of it for those types. + +`std::hash` is easy to use, and simplifies the code since you don't have to name it explicitly. Specializing `std::hash` is the standard way of specifying how to hash a type, so it's what outside resources will teach, and what new engineers will expect. + +`std::hash` is hard to specialize. It requires a lot of boilerplate code, and more importantly, it combines responsibility for identifying the hash inputs with responsibility for executing the hashing algorithm itself. The type author has to be responsible for the former, but the latter requires expertise that a type author usually doesn't have, and shouldn't need. The stakes here are high because low-quality hash functions can be security vulnerabilities, due to the emergence of http://emboss.github.io/blog/2012/12/14/breaking-murmur-hash-flooding-dos-reloaded/[hash flooding attacks]. + +Even for experts, `std::hash` specializations are inordinately difficult to implement correctly for compound types, because the implementation cannot recursively call `std::hash` on data members. High-quality hash algorithms maintain large amounts of internal state, and reducing that state to the `size_t` bytes that `std::hash` returns is usually the slowest part of the computation, so it should not be done more than once. + +Due to exactly that issue, `std::hash` does not work with `std::pair` or `std::tuple`, and the language does not allow us to extend it to support them. + +You can use `std::hash` with the types that it supports "out of the box", but do not specialize it to support additional types. If you need a hash table with a key type that `std::hash` does not support, consider using legacy hash containers (e.g. `hash_map`) for now; they use a different default hasher, which is unaffected by this prohibition. + +If you want to use the standard hash containers anyway, you will need to specify a custom hasher for the key type, e.g. + +------------------------------------------------------------- +std::unordered_map my_map; +------------------------------------------------------------- + +Consult with the type's owners to see if there is an existing hasher that you can use; otherwise work with them to provide one, or roll your own. + +We are planning to provide a hash function that can work with any type, using a new customization mechanism that doesn't have the drawbacks of `std::hash`. + +[[{cpp}11]] +=== {cpp}11 + +Use libraries and language extensions from {cpp}11 when appropriate. Consider portability to other environments before using {cpp}11 features in your project. + +{cpp}11 contains http://en.wikipedia.org/wiki/C%2B%2B11[significant changes] both to the language and libraries. + +{cpp}11 was the official standard until august 2014, and is supported by most {cpp} compilers. It standardizes some common {cpp} extensions that we use already, allows shorthands for some operations, and has some performance and safety improvements. + +The {cpp}11 standard is substantially more complex than its predecessor (1,300 pages versus 800 pages), and is unfamiliar to many developers. The long-term effects of some features on code readability and maintenance are unknown. We cannot predict when its various features will be implemented uniformly by tools that may be of interest, particularly in the case of projects that are forced to use older versions of tools. + +As with link:#Boost[Boost], some {cpp}11 extensions encourage coding practices that hamper readability—for example by removing checked redundancy (such as type names) that may be helpful to readers, or by encouraging template metaprogramming. Other extensions duplicate functionality available through existing mechanisms, which may lead to confusion and conversion costs. + +{cpp}11 features may be used unless specified otherwise. In addition to what's described in the rest of the style guide, the following {cpp}11 features may not be used: + +* Compile-time rational numbers (``), because of concerns that it's tied to a more template-heavy interface style. +* The `` and `` headers, because many compilers do not support those features reliably. + +[[Naming]] +== Naming + +The most important consistency rules are those that govern naming. The style of a name immediately informs us what sort of thing the named entity is: a type, a variable, a function, a constant, a macro, etc., without requiring us to search for the declaration of that entity. The pattern-matching engine in our brains relies a great deal on these naming rules. + +Naming rules are pretty arbitrary, but we feel that consistency is more important than individual preferences in this area, so regardless of whether you find them sensible or not, the rules are the rules. + +[[General_Naming_Rules]] +=== General Naming Rules + +Names should be descriptive; eschew abbreviation. + +Give as descriptive a name as possible, within reason. Do not worry about saving horizontal space as it is far more important to make your code immediately understandable by a new reader. Do not use abbreviations that are ambiguous or unfamiliar to readers outside your project, and do not abbreviate by deleting letters within a word. + +--------------------------------------------------------------------- +int price_count_reader; // No abbreviation. +int num_errors; // "num" is a widespread convention. +int num_dns_connections; // Most people know what "DNS" stands for. +--------------------------------------------------------------------- + +------------------------------------------------------------------------- +int n; // Meaningless. +int nerr; // Ambiguous abbreviation. +int n_comp_conns; // Ambiguous abbreviation. +int wgc_connections; // Only your group knows what this stands for. +int pc_reader; // Lots of things can be abbreviated "pc". +int cstmr_id; // Deletes internal letters. +------------------------------------------------------------------------- + +[[File_Names]] +=== File Names + +Filenames should be all lowercase and can include underscores (`_`) or dashes (`-`). Follow the convention that your project uses. If there is no consistent local pattern to follow, prefer "_". + +Examples of acceptable file names: + +* `my_useful_class.cc` +* `my-useful-class.cc` +* `myusefulclass.cc` +* `myusefulclass_test.cc // _unittest and _regtest are deprecated.` + +{cpp} files should end in `.cc` and header files should end in `.h`. Files that rely on being textually included at specific points should end in `.inc` (see also the section on link:#Self_contained_Headers[self-contained headers]). + +Do not use filenames that already exist in `/usr/include`, such as `db.h`. + +In general, make your filenames very specific. For example, use `http_server_logs.h` rather than `logs.h`. A very common case is to have a pair of files called, e.g., `foo_bar.h` and `foo_bar.cc`, defining a class called `FooBar`. + +Inline functions must be in a `.h` file. If your inline functions are very short, they should go directly into your `.h` file. + +[[Type_Names]] +=== Type Names + +Type names start with a capital letter and have a capital letter for each new word, with no underscores: `MyExcitingClass`, `MyExcitingEnum`. + +The names of all types — classes, structs, typedefs, enums, and type template parameters — have the same naming convention. Type names should start with a capital letter and have a capital letter for each new word. No underscores. For example: + +------------------------------------------------------------- +// classes and structs +class UrlTable { ... +class UrlTableTester { ... +struct UrlTableProperties { ... + +// typedefs +typedef hash_map PropertiesMap; + +// enums +enum UrlTableErrors { ... +------------------------------------------------------------- + +[[Variable_Names]] +=== Variable Names + +The names of variables and data members are all lowercase, with underscores between words. Data members of classes (but not structs) additionally have trailing underscores. For instance: `a_local_variable`, `a_struct_data_member`, `a_class_data_member_`. + +==== Common Variable names + +For example: + +-------------------------------------------- +string table_name; // OK - uses underscore. +string tablename; // OK - all lowercase. +-------------------------------------------- + +---------------------------------------- +string tableName; // Bad - mixed case. +---------------------------------------- + +==== Class Data Members + +Data members of classes, both static and non-static, are named like ordinary nonmember variables, but with a trailing underscore. + +------------------------------------------------- +class TableInfo { + ... + private: + string table_name_; // OK - underscore at end. + string tablename_; // OK. + static Pool* pool_; // OK. +}; +------------------------------------------------- + +==== Struct Data Members + +Data members of structs, both static and non-static, are named like ordinary nonmember variables. They do not have the trailing underscores that data members in classes have. + +---------------------------------------- +struct UrlTableProperties { + string name; + int num_entries; + static Pool* pool; +}; +---------------------------------------- + +See link:#Structs_vs._Classes[Structs vs. Classes] for a discussion of when to use a struct versus a class. + +==== Global Variables + +There are no special requirements for global variables, which should be rare in any case, but if you use one, consider prefixing it with `g_` or some other marker to easily distinguish it from local variables. + +[[Constant_Names]] +=== Constant Names + +Variables declared constexpr or const, and whose value is fixed for the duration of the program, are named with a leading "k" followed by mixed case. For example: + +--------------------------- +const int kDaysInAWeek = 7; +--------------------------- + +All such variables with static storage duration (i.e. statics and globals, see http://en.cppreference.com/w/cpp/language/storage_duration#Storage_duration[Storage Duration] for details) should be named this way. This convention is optional for variables of other storage classes, e.g. automatic variables, otherwise the usual variable naming rules apply. + +[[Function_Names]] +=== Function Names + +Regular functions have mixed case; "cheap" functions may use lower case with underscores. + +Ordinarily, functions should start with a capital letter and have a capital letter for each new word (a.k.a. "upper camel case" or "Pascal case"). Such names should not have underscores. Prefer to capitalize acronyms as single words (i.e. `StartRpc()`, not `StartRPC()`). + +--------------- +AddTableEntry() +DeleteUrl() +OpenFileOrDie() +--------------- + +Functions that are very cheap to call may instead follow the style for variable names (all lower-case, with underscores between words). The rule of thumb is that such a function should be so cheap that you normally wouldn't bother caching its return value when calling it in a loop. A canonical example is an inline method that just returns one of the class's member variables. + +----------------------------------------------------- +class MyClass { + public: + ... + bool is_empty() const { return num_entries_ == 0; } + + private: + int num_entries_; +}; +----------------------------------------------------- + +[[Namespace_Names]] +=== Namespace Names + +Namespace names are all lower-case. Top-level namespace names are based on the project name . + +The name of a top-level namespace should usually be the name of the project or team whose code is contained in that namespace. The code in that namespace should usually be in a directory whose basename matches the namespace name (or subdirectories thereof). + +Keep in mind that the link:#General_Naming_Rules[rule against abbreviated names] applies to namespaces just as much as variable names. Code inside the namespace seldom needs to mention the namespace name, so there's usually no particular need for abbreviation anyway. + +Naming conventions for nested namespaces are at the discretion of the team owning the enclosing namespace. If a nested namespace is used to group related functions in a single header file, consider basing its name on the header name, e.g. namespace `foo::bar` for functions defined in the header file `bar.h`. If the nested namespace is being used to distinguish implementation details from user-facing declarations, one common choice is `internal`. + +[[Enumerator_Names]] +=== Enumerator Names + +Enumerators should be named _either_ like link:#Constant_Names[constants] or like link:#Macro_Names[macros]: either `kEnumName` or `ENUM_NAME`. + +Preferably, the individual enumerators should be named like link:#Constant_Names[constants]. However, it is also acceptable to name them like link:Macro_Names[macros]. The enumeration name, `UrlTableErrors` (and `AlternateUrlTableErrors`), is a type, and therefore mixed case. + +------------------------------ +enum UrlTableErrors { + kOK = 0, + kErrorOutOfMemory, + kErrorMalformedInput, +}; +enum AlternateUrlTableErrors { + OK = 0, + OUT_OF_MEMORY = 1, + MALFORMED_INPUT = 2, +}; +------------------------------ + +Until January 2009, the style was to name enum values like link:#Macro_Names[macros]. This caused problems with name collisions between enum values and macros. Hence, the change to prefer constant-style naming was put in place. New code should prefer constant-style naming if possible. However, there is no reason to change old code to use constant-style names, unless the old names are actually causing a compile-time problem. + +[[Macro_Names]] +=== Macro Names + +You're not really going to link:#Preprocessor_Macros[define a macro], are you? If you do, they're like this: `MY_MACRO_THAT_SCARES_SMALL_CHILDREN`. + +Please see the link:#Preprocessor_Macros[description of macros]; in general macros should _not_ be used. However, if they are absolutely needed, then they should be named with all capitals and underscores. + +---------------------- +#define ROUND(x) ... +#define PI_ROUNDED 3.0 +---------------------- + +[[Exceptions_to_Naming_Rules]] +=== Exceptions to Naming Rules + +If you are naming something that is analogous to an existing C or {cpp} entity then you can follow the existing naming convention scheme. + +`bigopen()`:: + function name, follows form of `open()` +`uint`:: + `typedef` +`bigpos`:: + `struct` or `class`, follows form of `pos` +`sparse_hash_map`:: + STL-like entity; follows STL naming conventions +`LONGLONG_MAX`:: + a constant, as in `INT_MAX` + +[[Comments]] +== Comments + +Though a pain to write, comments are absolutely vital to keeping our code readable. The following rules describe what you should comment and where. But remember: while comments are very important, the best code is self-documenting. Giving sensible names to types and variables is much better than using obscure names that you must then explain through comments. + +When writing your comments, write for your audience: the next contributor who will need to understand your code. Be generous — the next one may be you! + +[[Comment_Style]] +=== Comment Style + +Use either the `//` or `/* */` syntax, as long as you are consistent. + +You can use either the `//` or the `/* */` syntax; however, `//` is _much_ more common. Be consistent with how you comment and what style you use where. + +[[File_Comments]] +=== File Comments + +Start each file with license boilerplate, followed by a description of its contents. + +==== Legal Notice and Author Line + +Every file should contain license boilerplate. Choose the appropriate boilerplate for the license used by the project (for example, Apache 2.0, BSD, LGPL, GPL). + +If you make significant changes to a file with an author line, consider deleting the author line. + +==== File Contents + +Every file should have a comment at the top describing its contents, unless the specific conditions described below apply. + +A file-level comment in a `.h` should broadly describe the contents of the file. If the file declares multiple abstractions, the file-level comment should document how they are related. A 1 or 2 sentence file-level comment may be sufficient. The detailed documentation about individual abstractions belongs with those abstractions, not at the file level. + +Do not duplicate comments in both the `.h` and the `.cc`. Duplicated comments diverge. + +A file-level comment may be omitted if the file declares, implements, or tests exactly one abstraction that is documented by a comment at the point of declaration. + +[[Class_Comments]] +=== Class Comments + +Every class definition should have an accompanying comment that describes what it is for and how it should be used. + +------------------------------------------------------------ +// Iterates over the contents of a GargantuanTable. +// Example: +// GargantuanTableIterator* iter = table->NewIterator(); +// for (iter->Seek("foo"); !iter->done(); iter->Next()) { +// process(iter->key(), iter->value()); +// } +// delete iter; +class GargantuanTableIterator { + ... +}; +------------------------------------------------------------ + +The class comment should provide the reader with enough information to know how and when to use the class, as well as any additional considerations necessary to correctly use the class. Document the synchronization assumptions the class makes, if any. If an instance of the class can be accessed by multiple threads, take extra care to document the rules and invariants surrounding multithreaded use. + +The class comment is often a good place for a small example code snippet demonstrating a simple and focused usage of the class. + +[[Function_Comments]] +=== Function Comments + +Declaration comments describe use of the function; comments at the definition of a function describe operation. + +==== Function Declarations + +Every function declaration should have comments immediately preceding it that describe what the function does and how to use it. These comments should be descriptive ("Opens the file") rather than imperative ("Open the file"); the comment describes the function, it does not tell the function what to do. In general, these comments do not describe how the function performs its task. Instead, that should be left to comments in the function definition. + +Types of things to mention in comments at the function declaration: + +* What the inputs and outputs are. +* For class member functions: whether the object remembers reference arguments beyond the duration of the method call, and whether it will free them or not. +* If the function allocates memory that the caller must free. +* Whether any of the arguments can be a null pointer. +* If there are any performance implications of how a function is used. +* If the function is re-entrant. What are its synchronization assumptions? + +Here is an example: + +---------------------------------------------------------------------- +// Returns an iterator for this table. It is the client's +// responsibility to delete the iterator when it is done with it, +// and it must not use the iterator once the GargantuanTable object +// on which the iterator was created has been deleted. +// +// The iterator is initially positioned at the beginning of the table. +// +// This method is equivalent to: +// Iterator* iter = table->NewIterator(); +// iter->Seek(""); +// return iter; +// If you are going to immediately seek to another place in the +// returned iterator, it will be faster to use NewIterator() +// and avoid the extra seek. +Iterator* GetIterator() const; +---------------------------------------------------------------------- + +However, do not be unnecessarily verbose or state the completely obvious. Notice below that it is not necessary to say "returns false otherwise" because this is implied. + +---------------------------------------------------------- +// Returns true if the table cannot hold any more entries. +bool IsTableFull(); +---------------------------------------------------------- + +When documenting function overrides, focus on the specifics of the override itself, rather than repeating the comment from the overriden function. In many of these cases, the override needs no additional documentation and thus no comment is required. + +When commenting constructors and destructors, remember that the person reading your code knows what constructors and destructors are for, so comments that just say something like "destroys this object" are not useful. Document what constructors do with their arguments (for example, if they take ownership of pointers), and what cleanup the destructor does. If this is trivial, just skip the comment. It is quite common for destructors not to have a header comment. + +==== Function Definitions + +If there is anything tricky about how a function does its job, the function definition should have an explanatory comment. For example, in the definition comment you might describe any coding tricks you use, give an overview of the steps you go through, or explain why you chose to implement the function in the way you did rather than using a viable alternative. For instance, you might mention why it must acquire a lock for the first half of the function but why it is not needed for the second half. + +Note you should _not_ just repeat the comments given with the function declaration, in the `.h` file or wherever. It's okay to recapitulate briefly what the function does, but the focus of the comments should be on how it does it. + +[[Variable_Comments]] +=== Variable Comments + +In general the actual name of the variable should be descriptive enough to give a good idea of what the variable is used for. In certain cases, more comments are required. + +==== Class Data Members + +Each class data member (also called an instance variable or member variable) should have a comment describing what it is used for. If the variable can take sentinel values with special meanings, such as a null pointer or -1, document this. For example: + +------------------------------------------------------------ +private: + // Keeps track of the total number of entries in the table. + // Used to ensure we do not go over the limit. -1 means + // that we don't yet know how many entries the table has. + int num_total_entries_; +------------------------------------------------------------ + +==== Global Variables + +As with data members, all global variables should have a comment describing what they are and what they are used for. For example: + +------------------------------------------------------------------------------- +// The total number of tests cases that we run through in this regression test. +const int kNumTestCases = 6; +------------------------------------------------------------------------------- + +[[Implementation_Comments]] +=== Implementation Comments + +In your implementation you should have comments in tricky, non-obvious, interesting, or important parts of your code. + +==== Explanatory Comments + +Tricky or complicated code blocks should have comments before them. Example: + +--------------------------------------------------- +// Divide result by two, taking into account that x +// contains the carry from the add. +for (int i = 0; i < result->size(); i++) { + x = (x << 8) + (*result)[i]; + (*result)[i] = x >> 1; + x &= 1; +} +--------------------------------------------------- + +==== Line Comments + +Also, lines that are non-obvious should get a comment at the end of the line. These end-of-line comments should be separated from the code by 2 spaces. Example: + +-------------------------------------------------------------------- +// If we have enough memory, mmap the data portion too. +mmap_budget = max(0, mmap_budget - index_->length()); +if (mmap_budget >= data_size_ && !MmapData(mmap_chunk_bytes, mlock)) + return; // Error already logged. +-------------------------------------------------------------------- + +Note that there are both comments that describe what the code is doing, and comments that mention that an error has already been logged when the function returns. + +If you have several comments on subsequent lines, it can often be more readable to line them up: + +------------------------------------------------------------------------------- +DoSomething(); // Comment here so the comments line up. +DoSomethingElseThatIsLonger(); // Two spaces between the code and the comment. +{ // One space before comment when opening a new scope is allowed, + // thus the comment lines up with the following comments and code. + DoSomethingElse(); // Two spaces before line comments normally. +} +vector list{// Comments in braced lists describe the next element .. + "First item", + // .. and should be aligned appropriately. + "Second item"}; +DoSomething(); /* For trailing block comments, one space is fine. */ +------------------------------------------------------------------------------- + +==== Function Argument Comments + +When the meaning of a function argument is nonobvious, consider one of the following remedies: + +* If the argument is a literal constant, and the same constant is used in multiple function calls in a way that tacitly assumes they're the same, you should use a named constant to make that constraint explicit, and to guarantee that it holds. +* Consider changing the function signature to replace a `bool` argument with an `enum` argument. This will make the argument values self-describing. +* For functions that have several configuration options, consider defining a single class or struct to hold all the options , and pass an instance of that. This approach has several advantages. Options are referenced by name at the call site, which clarifies their meaning. It also reduces function argument count, which makes function calls easier to read and write. As an added benefit, you don't have to change call sites when you add another option. +* Replace large or complex nested expressions with named variables. +* As a last resort, use comments to clarify argument meanings at the call site. + +Consider the following example: + +-------------------------------------------------------------------------- +// What are these arguments? +const DecimalNumber product = CalculateProduct(values, 7, false, nullptr); +-------------------------------------------------------------------------- + +versus: + +----------------------------------------------------------------------- +ProductOptions options; +options.set_precision_decimals(7); +options.set_use_cache(ProductOptions::kDontUseCache); +const DecimalNumber product = + CalculateProduct(values, options, /*completion_callback=*/nullptr); +----------------------------------------------------------------------- + +==== Don'ts + +Do not state the obvious. In particular, don't literally describe what code does, unless the behavior is nonobvious to a reader who understands {cpp} well. Instead, provide higher level comments that describe _why_ the code does what it does, or make the code self describing. + +Compare this: + +----------------------------------------------------- +// Find the element in the vector. <-- Bad: obvious! +auto iter = std::find(v.begin(), v.end(), element); +if (iter != v.end()) { + Process(element); +} +----------------------------------------------------- + +To this: + +----------------------------------------------------- +// Process "element" unless it was already processed. +auto iter = std::find(v.begin(), v.end(), element); +if (iter != v.end()) { + Process(element); +} +----------------------------------------------------- + +Self-describing code doesn't need a comment. The comment from the example above would be obvious: + +----------------------------------- +if (!IsAlreadyProcessed(element)) { + Process(element); +} +----------------------------------- + +[[Punctuation,_Spelling_and_Grammar]] +=== Punctuation, Spelling and Grammar + +Pay attention to punctuation, spelling, and grammar; it is easier to read well-written comments than badly written ones. + +Comments should be as readable as narrative text, with proper capitalization and punctuation. In many cases, complete sentences are more readable than sentence fragments. Shorter comments, such as comments at the end of a line of code, can sometimes be less formal, but you should be consistent with your style. + +Although it can be frustrating to have a code reviewer point out that you are using a comma when you should be using a semicolon, it is very important that source code maintain a high level of clarity and readability. Proper punctuation, spelling, and grammar help with that goal. + +[[TODO_Comments]] +=== TODO Comments + +Use `TODO` comments for code that is temporary, a short-term solution, or good-enough but not perfect. + +`TODO`s should include the string `TODO` in all caps, followed by the name, e-mail address, or other identifier of the person with the best context about the problem referenced by the `TODO`. The main purpose is to have a consistent `TODO` that can be searched to find out how to get more details upon request. A `TODO` is not a commitment that the person referenced will fix the problem. Thus when you create a `TODO`, it is almost always your name that is given. + +----------------------------------------------------------------- +// TODO(kl@gmail.com): Use a "*" here for concatenation operator. +// TODO(Zeke) change this to use relations. +----------------------------------------------------------------- + +If your `TODO` is of the form "At a future date do something" make sure that you either include a very specific date ("Fix by November 2005") or a very specific event ("Remove this code when all clients can handle XML responses."). + +[[Deprecation_Comments]] +=== Deprecation Comments + +Mark deprecated interface points with `DEPRECATED` comments. + +You can mark an interface as deprecated by writing a comment containing the word `DEPRECATED` in all caps. The comment goes either before the declaration of the interface or on the same line as the declaration. + +After the word `DEPRECATED`, write your name, e-mail address, or other identifier in parentheses. + +A deprecation comment must include simple, clear directions for people to fix their callsites. In {cpp}, you can implement a deprecated function as an inline function that calls the new interface point. + +Marking an interface point `DEPRECATED` will not magically cause any callsites to change. If you want people to actually stop using the deprecated facility, you will have to fix the callsites yourself or recruit a crew to help you. + +New code should not contain calls to deprecated interface points. Use the new interface point instead. If you cannot understand the directions, find the person who created the deprecation and ask them for help using the new interface point. + +[[Formatting]] +== Formatting + +Coding style and formatting are pretty arbitrary, but a project is much easier to follow if everyone uses the same style. Individuals may not agree with every aspect of the formatting rules, and some of the rules may take some getting used to, but it is important that all project contributors follow the style rules so that they can all read and understand everyone's code easily. + +To help you format code correctly, we've created a http://google-styleguide.googlecode.com/svn/trunk/google-c-style.el[settings file for emacs]. + +[[Line_Length]] +=== Line Length + +Each line of text in your code should be at most 80 characters long. + +We recognize that this rule is controversial, but so much existing code already adheres to it, and we feel that consistency is important. + +Those who favor this rule argue that it is rude to force them to resize their windows and there is no need for anything longer. Some folks are used to having several code windows side-by-side, and thus don't have room to widen their windows in any case. People set up their work environment assuming a particular maximum window width, and 80 columns has been the traditional standard. Why change it? + +Proponents of change argue that a wider line can make code more readable. The 80-column limit is an hidebound throwback to 1960s mainframes; modern equipment has wide screens that can easily show longer lines. + +80 characters is the maximum. + +Comment lines can be longer than 80 characters if it is not feasible to split them without harming readability, ease of cut and paste or auto-linking -- e.g. if a line contains an example command or a literal URL longer than 80 characters. + +A raw-string literal may have content that exceeds 80 characters. Except for test code, such literals should appear near top of a file. + +An `#include` statement with a long path may exceed 80 columns. + +You needn't be concerned about link:#The__define_Guard[header guards] that exceed the maximum length. + +[[Non-ASCII_Characters]] +=== Non-ASCII Characters + +Non-ASCII characters should be rare, and must use UTF-8 formatting. + +You shouldn't hard-code user-facing text in source, even English, so use of non-ASCII characters should be rare. However, in certain cases it is appropriate to include such words in your code. For example, if your code parses data files from foreign sources, it may be appropriate to hard-code the non-ASCII string(s) used in those data files as delimiters. More commonly, unittest code (which does not need to be localized) might contain non-ASCII strings. In such cases, you should use UTF-8, since that is an encoding understood by most tools able to handle more than just ASCII. + +Hex encoding is also OK, and encouraged where it enhances readability — for example, `"\xEF\xBB\xBF"`, or, even more simply, `u8"\uFEFF"`, is the Unicode zero-width no-break space character, which would be invisible if included in the source as straight UTF-8. + +Use the `u8` prefix to guarantee that a string literal containing `\uXXXX` escape sequences is encoded as UTF-8. Do not use it for strings containing non-ASCII characters encoded as UTF-8, because that will produce incorrect output if the compiler does not interpret the source file as UTF-8. + +You shouldn't use the {cpp}11 `char16_t` and `char32_t` character types, since they're for non-UTF-8 text. For similar reasons you also shouldn't use `wchar_t` (unless you're writing code that interacts with the Windows API, which uses `wchar_t` extensively). + +[[Spaces_vs._Tabs]] +=== Spaces vs. Tabs + +Use only spaces, and indent 2 spaces at a time. + +We use spaces for indentation. Do not use tabs in your code. You should set your editor to emit spaces when you hit the tab key. + +[[Function_Declarations_and_Definitions]] +=== Function Declarations and Definitions + +Return type on the same line as function name, parameters on the same line if they fit. Wrap parameter lists which do not fit on a single line as you would wrap arguments in a function call. + +Functions look like this: + +-------------------------------------------------------------------- +ReturnType ClassName::FunctionName(Type par_name1, Type par_name2) { + DoSomething(); + ... +} +-------------------------------------------------------------------- + +If you have too much text to fit on one line: + +---------------------------------------------------------------------------- +ReturnType ClassName::ReallyLongFunctionName(Type par_name1, Type par_name2, + Type par_name3) { + DoSomething(); + ... +} +---------------------------------------------------------------------------- + +or if you cannot fit even the first parameter: + +------------------------------------------------------------- +ReturnType LongClassName::ReallyReallyReallyLongFunctionName( + Type par_name1, // 4 space indent + Type par_name2, + Type par_name3) { + DoSomething(); // 2 space indent + ... +} +------------------------------------------------------------- + +Some points to note: + +* Choose good parameter names. +* Parameter names may be omitted only if the parameter is unused and its purpose is obvious. +* If you cannot fit the return type and the function name on a single line, break between them. +* If you break after the return type of a function declaration or definition, do not indent. +* The open parenthesis is always on the same line as the function name. +* There is never a space between the function name and the open parenthesis. +* There is never a space between the parentheses and the parameters. +* The open curly brace is always on the end of the last line of the function declaration, not the start of the next line. +* The close curly brace is either on the last line by itself or on the same line as the open curly brace. +* There should be a space between the close parenthesis and the open curly brace. +* All parameters should be aligned if possible. +* Default indentation is 2 spaces. +* Wrapped parameters have a 4 space indent. + +Unused parameters that are obvious from context may be omitted: + +--------------------------------------- +class Foo { + public: + Foo(Foo&&) = default; + Foo(const Foo&) = default; + Foo& operator=(Foo&&) = default; + Foo& operator=(const Foo&) = default; +}; +--------------------------------------- + +Unused parameters that might not be obvious should comment out the variable name in the function definition: + +------------------------------------------ +class Shape { + public: + virtual void Rotate(double radians) = 0; +}; + +class Circle : public Shape { + public: + void Rotate(double radians) override; +}; + +void Circle::Rotate(double /*radians*/) {} +------------------------------------------ + +--------------------------------------------------------------------- +// Bad - if someone wants to implement later, it's not clear what the +// variable means. +void Circle::Rotate(double) {} +--------------------------------------------------------------------- + +[[Formatting_Lambda_Expressions]] +=== Lambda Expressions + +Format parameters and bodies as for any other function, and capture lists like other comma-separated lists. + +For by-reference captures, do not leave a space between the ampersand (&) and the variable name. + +---------------------------------------- +int x = 0; +auto add_to_x = [&x](int n) { x += n; }; +---------------------------------------- + +Short lambdas may be written inline as function arguments. + +------------------------------------------------------------------------------- +set blacklist = {7, 8, 9}; +vector digits = {3, 9, 1, 8, 4, 7, 1}; +digits.erase(std::remove_if(digits.begin(), digits.end(), [&blacklist](int i) { + return blacklist.find(i) != blacklist.end(); + }), + digits.end()); +------------------------------------------------------------------------------- + +[[Function_Calls]] +=== Function Calls + +Either write the call all on a single line, wrap the arguments at the parenthesis, or start the arguments on a new line indented by four spaces and continue at that 4 space indent. In the absence of other considerations, use the minimum number of lines, including placing multiple arguments on each line where appropriate. + +Function calls have the following format: + +----------------------------------------------------------- +bool result = DoSomething(argument1, argument2, argument3); +----------------------------------------------------------- + +If the arguments do not all fit on one line, they should be broken up onto multiple lines, with each subsequent line aligned with the first argument. Do not add spaces after the open paren or before the close paren: + +--------------------------------------------------------- +bool result = DoSomething(averyveryveryverylongargument1, + argument2, argument3); +--------------------------------------------------------- + +Arguments may optionally all be placed on subsequent lines with a four space indent: + +------------------------------------------------ +if (...) { + ... + ... + if (...) { + bool result = DoSomething( + argument1, argument2, // 4 space indent + argument3, argument4); + ... + } +------------------------------------------------ + +Put multiple arguments on a single line to reduce the number of lines necessary for calling a function unless there is a specific readability problem. Some find that formatting with strictly one argument on each line is more readable and simplifies editing of the arguments. However, we prioritize for the reader over the ease of editing arguments, and most readability problems are better addressed with the following techniques. + +If having multiple arguments in a single line decreases readability due to the complexity or confusing nature of the expressions that make up some arguments, try creating variables that capture those arguments in a descriptive name: + +------------------------------------------------- +int my_heuristic = scores[x] * y + bases[x]; +bool result = DoSomething(my_heuristic, x, y, z); +------------------------------------------------- + +Or put the confusing argument on its own line with an explanatory comment: + +------------------------------------------------------------------------ +bool result = DoSomething(scores[x] * y + bases[x], // Score heuristic. + x, y, z); +------------------------------------------------------------------------ + +If there is still a case where one argument is significantly more readable on its own line, then put it on its own line. The decision should be specific to the argument which is made more readable rather than a general policy. + +Sometimes arguments form a structure that is important for readability. In those cases, feel free to format the arguments according to that structure: + +---------------------------------------- +// Transform the widget by a 3x3 matrix. +my_widget.Transform(x1, x2, x3, + y1, y2, y3, + z1, z2, z3); +---------------------------------------- + +[[Braced_Initializer_List_Format]] +=== Braced Initializer List Format + +Format a link:#Braced_Initializer_List[braced initializer list] exactly like you would format a function call in its place. + +If the braced list follows a name (e.g. a type or variable name), format as if the `{}` were the parentheses of a function call with that name. If there is no name, assume a zero-length name. + +------------------------------------------------------------- +// Examples of braced init list on a single line. +return {foo, bar}; +functioncall({foo, bar}); +pair p{foo, bar}; + +// When you have to wrap. +SomeFunction( + {"assume a zero-length name before {"}, + some_other_function_parameter); +SomeType variable{ + some, other, values, + {"assume a zero-length name before {"}, + SomeOtherType{ + "Very long string requiring the surrounding breaks.", + some, other values}, + SomeOtherType{"Slightly shorter string", + some, other, values}}; +SomeType variable{ + "This is too long to fit all in one line"}; +MyType m = { // Here, you could also break before {. + superlongvariablename1, + superlongvariablename2, + {short, interior, list}, + {interiorwrappinglist, + interiorwrappinglist2}}; +------------------------------------------------------------- + +[[Conditionals]] +=== Conditionals + +Prefer no spaces inside parentheses. The `if` and `else` keywords belong on separate lines. + +There are two acceptable formats for a basic conditional statement. One includes spaces between the parentheses and the condition, and one does not. + +The most common form is without spaces. Either is fine, but __be consistent__. If you are modifying a file, use the format that is already present. If you are writing new code, use the format that the other files in that directory or project use. If in doubt and you have no personal preference, do not add the spaces. + +-------------------------------------------------------------------------- +if (condition) { // no spaces inside parentheses + ... // 2 space indent. +} else if (...) { // The else goes on the same line as the closing brace. + ... +} else { + ... +} +-------------------------------------------------------------------------- + +If you prefer you may add spaces inside the parentheses: + +----------------------------------------------------------------- +if ( condition ) { // spaces inside parentheses - rare + ... // 2 space indent. +} else { // The else goes on the same line as the closing brace. + ... +} +----------------------------------------------------------------- + +Note that in all cases you must have a space between the `if` and the open parenthesis. You must also have a space between the close parenthesis and the curly brace, if you're using one. + +-------------------------------------------------- +if(condition) { // Bad - space missing after IF. +if (condition){ // Bad - space missing before {. +if(condition){ // Doubly bad. +-------------------------------------------------- + +--------------------------------------------------------------- +if (condition) { // Good - proper space after IF and before {. +--------------------------------------------------------------- + +Short conditional statements may be written on one line if this enhances readability. You may use this only when the line is brief and the statement does not use the `else` clause. + +-------------------------------- +if (x == kFoo) return new Foo(); +if (x == kBar) return new Bar(); +-------------------------------- + +This is not allowed when the if statement has an `else`: + +---------------------------------------------------------------------- +// Not allowed - IF statement on one line when there is an ELSE clause +if (x) DoThis(); +else DoThat(); +---------------------------------------------------------------------- + +In general, curly braces are not required for single-line statements, but they are allowed if you like them; conditional or loop statements with complex conditions or statements may be more readable with curly braces. Some projects require that an `if` must always always have an accompanying brace. + +------------------------------------ +if (condition) + DoSomething(); // 2 space indent. + +if (condition) { + DoSomething(); // 2 space indent. +} +------------------------------------ + +However, if one part of an `if`-`else` statement uses curly braces, the other part must too: + +----------------------------------------- +// Not allowed - curly on IF but not ELSE +if (condition) { + foo; +} else + bar; + +// Not allowed - curly on ELSE but not IF +if (condition) + foo; +else { + bar; +} +----------------------------------------- + +-------------------------------------------------------- +// Curly braces around both IF and ELSE required because +// one of the clauses used braces. +if (condition) { + foo; +} else { + bar; +} +-------------------------------------------------------- + +[[Loops_and_Switch_Statements]] +=== Loops and Switch Statements + +Switch statements may use braces for blocks. Annotate non-trivial fall-through between cases. Braces are optional for single-statement loops. Empty loop bodies should use `{}` or `continue`. + +`case` blocks in `switch` statements can have curly braces or not, depending on your preference. If you do include curly braces they should be placed as shown below. + +If not conditional on an enumerated value, switch statements should always have a `default` case (in the case of an enumerated value, the compiler will warn you if any values are not handled). If the default case should never execute, simply `assert`: + +------------------------------ +switch (var) { + case 0: { // 2 space indent + ... // 4 space indent + break; + } + case 1: { + ... + break; + } + default: { + assert(false); + } +} +------------------------------ + +Braces are optional for single-statement loops. + +--------------------------------------- +for (int i = 0; i < kSomeNumber; ++i) + printf("I love you\n"); + +for (int i = 0; i < kSomeNumber; ++i) { + printf("I take it back\n"); +} +--------------------------------------- + +Empty loop bodies should use `{}` or `continue`, but not a single semicolon. + +------------------------------------------------------------------- +while (condition) { + // Repeat test until it returns false. +} +for (int i = 0; i < kSomeNumber; ++i) {} // Good - empty body. +while (condition) continue; // Good - continue indicates no logic. +------------------------------------------------------------------- + +-------------------------------------------------------------- +while (condition); // Bad - looks like part of do/while loop. +-------------------------------------------------------------- + +[[Pointer_and_Reference_Expressions]] +=== Pointer and Reference Expressions + +No spaces around period or arrow. Pointer operators do not have trailing spaces. + +The following are examples of correctly-formatted pointer and reference expressions: + +--------- +x = *p; +p = &x; +x = r.y; +x = r->y; +--------- + +Note that: + +* There are no spaces around the period or arrow when accessing a member. +* Pointer operators have no space after the `*` or `&`. + +When declaring a pointer variable or argument, you may place the asterisk adjacent to either the type or to the variable name: + +---------------------------------------------------------- +// These are fine, space preceding. +char *c; +const string &str; + +// These are fine, space following. +char* c; // but remember to do "char* c, *d, *e, ...;"! +const string& str; +---------------------------------------------------------- + +------------------------------------------------------- +char * c; // Bad - spaces on both sides of * +const string & str; // Bad - spaces on both sides of & +------------------------------------------------------- + +You should do this consistently within a single file, so, when modifying an existing file, use the style in that file. + +[[Boolean_Expressions]] +=== Boolean Expressions + +When you have a boolean expression that is longer than the link:#Line_Length[standard line length], be consistent in how you break up the lines. + +In this example, the logical AND operator is always at the end of the lines: + +---------------------------------------- +if (this_one_thing > this_other_thing && + a_third_thing == a_fourth_thing && + yet_another && last_one) { + ... +} +---------------------------------------- + +Note that when the code wraps in this example, both of the `&&` logical AND operators are at the end of the line. This is more common in Google code, though wrapping all operators at the beginning of the line is also allowed. Feel free to insert extra parentheses judiciously because they can be very helpful in increasing readability when used appropriately. Also note that you should always use the punctuation operators, such as `&&` and `~`, rather than the word operators, such as `and` and `compl`. + +[[Return_Values]] +=== Return Values + +Do not needlessly surround the `return` expression with parentheses. + +Use parentheses in `return expr;` only where you would use them in `x = expr;`. + +--------------------------------------------------------------------- +return result; // No parentheses in the simple case. +// Parentheses OK to make a complex expression more readable. +return (some_long_condition && + another_condition); +--------------------------------------------------------------------- + +------------------------------------------------------------------- +return (value); // You wouldn't write var = (value); +return(result); // return is not a function! +------------------------------------------------------------------- + +[[Variable_and_Array_Initialization]] +=== Variable and Array Initialization + +Your choice of `=`, `()`, or `{}`. + +You may choose between `=`, `()`, and `{}`; the following are all correct: + +-------------------------- +int x = 3; +int x(3); +int x{3}; +string name = "Some Name"; +string name("Some Name"); +string name{"Some Name"}; +-------------------------- + +Be careful when using a braced initialization list `{...}` on a type with an `std::initializer_list` constructor. A nonempty _braced-init-list_ prefers the `std::initializer_list` constructor whenever possible. Note that empty braces `{}` are special, and will call a default constructor if available. To force the non-`std::initializer_list` constructor, use parentheses instead of braces. + +---------------------------------------------- +vector v(100, 1); // A vector of 100 1s. +vector v{100, 1}; // A vector of 100, 1. +---------------------------------------------- + +Also, the brace form prevents narrowing of integral types. This can prevent some types of programming errors. + +------------------------------------------------------ +int pi(3.14); // OK -- pi == 3. +int pi{3.14}; // Compile error: narrowing conversion. +------------------------------------------------------ + +[[Preprocessor_Directives]] +=== Preprocessor Directives + +The hash mark that starts a preprocessor directive should always be at the beginning of the line. + +Even when preprocessor directives are within the body of indented code, the directives should start at the beginning of the line. + +------------------------------------------------------------------- +// Good - directives at beginning of line + if (lopsided_score) { +#if DISASTER_PENDING // Correct -- Starts at beginning of line + DropEverything(); +# if NOTIFY // OK but not required -- Spaces after # + NotifyClient(); +# endif +#endif + BackToNormal(); + } +------------------------------------------------------------------- + +----------------------------------------------------------------------------- +// Bad - indented directives + if (lopsided_score) { + #if DISASTER_PENDING // Wrong! The "#if" should be at beginning of line + DropEverything(); + #endif // Wrong! Do not indent "#endif" + BackToNormal(); + } +----------------------------------------------------------------------------- + +[[Class_Format]] +=== Class Format + +Sections in `public`, `protected` and `private` order, each indented one space. + +The basic format for a class declaration (lacking the comments, see link:#Class_Comments[Class Comments] for a discussion of what comments are needed) is: + +------------------------------------------------- +class MyClass : public OtherClass { + public: // Note the 1 space indent! + MyClass(); // Regular 2 space indent. + explicit MyClass(int var); + ~MyClass() {} + + void SomeFunction(); + void SomeFunctionThatDoesNothing() { + } + + void set_some_var(int var) { some_var_ = var; } + int some_var() const { return some_var_; } + + private: + bool SomeInternalFunction(); + + int some_var_; + int some_other_var_; +}; +------------------------------------------------- + +Things to note: + +* Any base class name should be on the same line as the subclass name, subject to the 80-column limit. +* The `public:`, `protected:`, and `private:` keywords should be indented one space. +* Except for the first instance, these keywords should be preceded by a blank line. This rule is optional in small classes. +* Do not leave a blank line after these keywords. +* The `public` section should be first, followed by the `protected` and finally the `private` section. +* See link:#Declaration_Order[Declaration Order] for rules on ordering declarations within each of these sections. + +[[Constructor_Initializer_Lists]] +=== Constructor Initializer Lists + +Constructor initializer lists can be all on one line or with subsequent lines indented four spaces. + +The acceptable formats for initializer lists are: + +---------------------------------------------------------------------- +// When everything fits on one line: +MyClass::MyClass(int var) : some_var_(var) { + DoSomething(); +} + +// If the signature and initializer list are not all on one line, +// you must wrap before the colon and indent 4 spaces: +MyClass::MyClass(int var) + : some_var_(var), some_other_var_(var + 1) { + DoSomething(); +} + +// When the list spans multiple lines, put each member on its own line +// and align them: +MyClass::MyClass(int var) + : some_var_(var), // 4 space indent + some_other_var_(var + 1) { // lined up + DoSomething(); +} + +// As with any other code block, the close curly can be on the same +// line as the open curly, if it fits. +MyClass::MyClass(int var) + : some_var_(var) {} +---------------------------------------------------------------------- + +[[Namespace_Formatting]] +=== Namespace Formatting + +The contents of namespaces are not indented. + +link:#Namespaces[Namespaces] do not add an extra level of indentation. For example, use: + +----------------------------------------------------------------- +namespace { + +void foo() { // Correct. No extra indentation within namespace. + ... +} + +} // namespace +----------------------------------------------------------------- + +Do not indent within a namespace: + +-------------------------------------------- +namespace { + + // Wrong. Indented when it should not be. + void foo() { + ... + } + +} // namespace +-------------------------------------------- + +When declaring nested namespaces, put each namespace on its own line. + +--------------- +namespace foo { +namespace bar { +--------------- + +[[Horizontal_Whitespace]] +=== Horizontal Whitespace + +Use of horizontal whitespace depends on location. Never put trailing whitespace at the end of a line. + +==== General + +------------------------------------------------------------------------------ +void f(bool b) { // Open braces should always have a space before them. + ... +int i = 0; // Semicolons usually have no space before them. +// Spaces inside braces for braced-init-list are optional. If you use them, +// put them on both sides! +int x[] = { 0 }; +int x[] = {0}; + +// Spaces around the colon in inheritance and initializer lists. +class Foo : public Bar { + public: + // For inline function implementations, put spaces between the braces + // and the implementation itself. + Foo(int b) : Bar(), baz_(b) {} // No spaces inside empty braces. + void Reset() { baz_ = 0; } // Spaces separating braces from implementation. + ... +------------------------------------------------------------------------------ + +Adding trailing whitespace can cause extra work for others editing the same file, when they merge, as can removing existing trailing whitespace. So: Don't introduce trailing whitespace. Remove it if you're already changing that line, or do it in a separate clean-up operation (preferably when no-one else is working on the file). + +==== Loops and Conditionals + +---------------------------------------------------------------------------- +if (b) { // Space after the keyword in conditions and loops. +} else { // Spaces around else. +} +while (test) {} // There is usually no space inside parentheses. +switch (i) { +for (int i = 0; i < 5; ++i) { +// Loops and conditions may have spaces inside parentheses, but this +// is rare. Be consistent. +switch ( i ) { +if ( test ) { +for ( int i = 0; i < 5; ++i ) { +// For loops always have a space after the semicolon. They may have a space +// before the semicolon, but this is rare. +for ( ; i < 5 ; ++i) { + ... + +// Range-based for loops always have a space before and after the colon. +for (auto x : counts) { + ... +} +switch (i) { + case 1: // No space before colon in a switch case. + ... + case 2: break; // Use a space after a colon if there's code after it. +---------------------------------------------------------------------------- + +==== Operators + +------------------------------------------------------------------- +// Assignment operators always have spaces around them. +x = 0; + +// Other binary operators usually have spaces around them, but it's +// OK to remove spaces around factors. Parentheses should have no +// internal padding. +v = w * x + y / z; +v = w*x + y/z; +v = w * (x + z); + +// No spaces separating unary operators and their arguments. +x = -5; +++x; +if (x && !y) + ... +------------------------------------------------------------------- + +==== Templates and Casts + +--------------------------------------------------------------- +// No spaces inside the angle brackets (< and >), before +// <, or between >( in a cast +vector x; +y = static_cast(x); + +// Spaces between type and pointer are OK, but be consistent. +vector x; +set> x; // Permitted in {cpp}11 code. +set > x; // {cpp}03 required a space in > >. + +// You may optionally use symmetric spacing in < <. +set< list > x; +--------------------------------------------------------------- + +[[Vertical_Whitespace]] +=== Vertical Whitespace + +Minimize use of vertical whitespace. + +This is more a principle than a rule: don't use blank lines when you don't have to. In particular, don't put more than one or two blank lines between functions, resist starting functions with a blank line, don't end functions with a blank line, and be discriminating with your use of blank lines inside functions. + +The basic principle is: The more code that fits on one screen, the easier it is to follow and understand the control flow of the program. Of course, readability can suffer from code being too dense as well as too spread out, so use your judgement. But in general, minimize use of vertical whitespace. + +Some rules of thumb to help when blank lines may be useful: + +* Blank lines at the beginning or end of a function very rarely help readability. +* Blank lines inside a chain of if-else blocks may well help readability. + +[[Exceptions_to_the_Rules]] +== Exceptions to the Rules + +The coding conventions described above are mandatory. However, like all good rules, these sometimes have exceptions, which we discuss here. + +[[Existing_Non-conformant_Code]] +=== Existing Non-conformant Code + +You may diverge from the rules when dealing with code that does not conform to this style guide. + +If you find yourself modifying code that was written to specifications other than those presented by this guide, you may have to diverge from these rules in order to stay consistent with the local conventions in that code. If you are in doubt about how to do this, ask the original author or the person currently responsible for the code. Remember that _consistency_ includes local consistency, too. + +[[Windows_Code]] +=== Windows Code + +Windows programmers have developed their own set of coding conventions, mainly derived from the conventions in Windows headers and other Microsoft code. We want to make it easy for anyone to understand your code, so we have a single set of guidelines for everyone writing {cpp} on any platform. + +It is worth reiterating a few of the guidelines that you might forget if you are used to the prevalent Windows style: + +* Do not use Hungarian notation (for example, naming an integer `iNum`). Use the Google naming conventions, including the `.cc` extension for source files. +* Windows defines many of its own synonyms for primitive types, such as `DWORD`, `HANDLE`, etc. It is perfectly acceptable, and encouraged, that you use these types when calling Windows API functions. Even so, keep as close as you can to the underlying {cpp} types. For example, use `const TCHAR *` instead of `LPCTSTR`. +* When compiling with Microsoft Visual {cpp}, set the compiler to warning level 3 or higher, and treat all warnings as errors. +* Do not use `#pragma once`; instead use the standard Google include guards. The path in the include guards should be relative to the top of your project tree. +* In fact, do not use any nonstandard extensions, like `#pragma` and `__declspec`, unless you absolutely must. Using `__declspec(dllimport)` and `__declspec(dllexport)` is allowed; however, you must use them through macros such as `DLLIMPORT` and `DLLEXPORT`, so that someone can easily disable the extensions if they share the code. + +However, there are just a few rules that we occasionally need to break on Windows: + +* Normally we link:#Multiple_Inheritance[forbid the use of multiple implementation inheritance]; however, it is required when using COM and some ATL/WTL classes. You may use multiple implementation inheritance to implement COM or ATL/WTL classes and interfaces. +* Although you should not use exceptions in your own code, they are used extensively in the ATL and some STLs, including the one that comes with Visual {cpp}. When using the ATL, you should define `_ATL_NO_EXCEPTIONS` to disable exceptions. You should investigate whether you can also disable exceptions in your STL, but if not, it is OK to turn on exceptions in the compiler. (Note that this is only to get the STL to compile. You should still not write exception handling code yourself.) +* The usual way of working with precompiled headers is to include a header file at the top of each source file, typically with a name like `StdAfx.h` or `precompile.h`. To make your code easier to share with other projects, avoid including this file explicitly (except in `precompile.cc`), and use the `/FI` compiler option to include the file automatically. +* Resource headers, which are usually named `resource.h` and contain only macros, do not need to conform to these style guidelines. + +== Parting Words + +Use common sense and __BE CONSISTENT__. + +If you are editing code, take a few minutes to look at the code around you and determine its style. If they use spaces around their `if` clauses, you should, too. If their comments have little boxes of stars around them, make your comments have little boxes of stars around them too. + +The point of having style guidelines is to have a common vocabulary of coding so people can concentrate on what you are saying, rather than on how you are saying it. We present global style rules here so people know the vocabulary. But local style is also important. If code you add to a file looks drastically different from the existing code around it, the discontinuity throws readers out of their rhythm when they go to read it. Try to avoid this. + +OK, enough writing about writing code; the code itself is much more interesting. Have fun! + +''''' diff --git a/cppguide.html b/cppguide.html deleted file mode 100644 index 0195cec..0000000 --- a/cppguide.html +++ /dev/null @@ -1,6117 +0,0 @@ - - - - -Google C++ Style Guide - - - - -
-

Google C++ Style Guide

-
- -
- - - -

C++ is the main development language used by -many of Google's open-source projects. As every C++ -programmer knows, the language has many powerful features, but -this power brings with it complexity, which in turn can make -code more bug-prone and harder to read and maintain.

- -

The goal of this guide is to manage this complexity by -describing in detail the dos and don'ts of writing C++ code. -These rules exist to -keep the code base manageable while still allowing -coders to use C++ language features productively.

- -

Style, also known as readability, is what we call -the conventions that govern our C++ code. The term Style is a -bit of a misnomer, since these conventions cover far more than -just source file formatting.

- -

-Most open-source projects developed by -Google conform to the requirements in this guide. -

- - - - - -

Note that this guide is not a C++ tutorial: we assume that -the reader is familiar with the language.

- -

Goals of the Style Guide

-
-

Why do we have this document?

- -

There are a few core goals that we believe this guide should -serve. These are the fundamental whys that -underlie all of the individual rules. By bringing these ideas to -the fore, we hope to ground discussions and make it clearer to our -broader community why the rules are in place and why particular -decisions have been made. If you understand what goals each rule is -serving, it should be clearer to everyone when a rule may be waived -(some can be), and what sort of argument or alternative would be -necessary to change a rule in the guide.

- -

The goals of the style guide as we currently see them are as follows:

-
-
Style rules should pull their weight
-
The benefit of a style rule -must be large enough to justify asking all of our engineers to -remember it. The benefit is measured relative to the codebase we would -get without the rule, so a rule against a very harmful practice may -still have a small benefit if people are unlikely to do it -anyway. This principle mostly explains the rules we don’t have, rather -than the rules we do: for example, goto contravenes many -of the following principles, but is already vanishingly rare, so the Style -Guide doesn’t discuss it.
- -
Optimize for the reader, not the writer
-
Our codebase (and most individual components submitted to it) is -expected to continue for quite some time. As a result, more time will -be spent reading most of our code than writing it. We explicitly -choose to optimize for the experience of our average software engineer -reading, maintaining, and debugging code in our codebase rather than -ease when writing said code. "Leave a trace for the reader" is a -particularly common sub-point of this principle: When something -surprising or unusual is happening in a snippet of code (for example, -transfer of pointer ownership), leaving textual hints for the reader -at the point of use is valuable (std::unique_ptr -demonstrates the ownership transfer unambiguously at the call -site).
- -
Be consistent with existing code
-
Using one style consistently through our codebase lets us focus on -other (more important) issues. Consistency also allows for -automation: tools that format your code or adjust -your #includes only work properly when your code is -consistent with the expectations of the tooling. In many cases, rules -that are attributed to "Be Consistent" boil down to "Just pick one and -stop worrying about it"; the potential value of allowing flexibility -on these points is outweighed by the cost of having people argue over -them.
- -
Be consistent with the broader C++ community when appropriate
-
Consistency with the way other organizations use C++ has value for -the same reasons as consistency within our code base. If a feature in -the C++ standard solves a problem, or if some idiom is widely known -and accepted, that's an argument for using it. However, sometimes -standard features and idioms are flawed, or were just designed without -our codebase's needs in mind. In those cases (as described below) it's -appropriate to constrain or ban standard features. In some cases we -prefer a homegrown or third-party library over a library defined in -the C++ Standard, either out of perceived superiority or insufficient -value to transition the codebase to the standard interface.
- -
Avoid surprising or dangerous constructs
-
C++ has features that are more surprising or dangerous than one -might think at a glance. Some style guide restrictions are in place to -prevent falling into these pitfalls. There is a high bar for style -guide waivers on such restrictions, because waiving such rules often -directly risks compromising program correctness. -
- -
Avoid constructs that our average C++ programmer would find tricky -or hard to maintain
-
C++ has features that may not be generally appropriate because of -the complexity they introduce to the code. In widely used -code, it may be more acceptable to use -trickier language constructs, because any benefits of more complex -implementation are multiplied widely by usage, and the cost in understanding -the complexity does not need to be paid again when working with new -portions of the codebase. When in doubt, waivers to rules of this type -can be sought by asking -your project leads. This is specifically -important for our codebase because code ownership and team membership -changes over time: even if everyone that works with some piece of code -currently understands it, such understanding is not guaranteed to hold a -few years from now.
- -
Be mindful of our scale
-
With a codebase of 100+ million lines and thousands of engineers, -some mistakes and simplifications for one engineer can become costly -for many. For instance it's particularly important to -avoid polluting the global namespace: name collisions across a -codebase of hundreds of millions of lines are difficult to work with -and hard to avoid if everyone puts things into the global -namespace.
- -
Concede to optimization when necessary
-
Performance optimizations can sometimes be necessary and -appropriate, even when they conflict with the other principles of this -document.
-
- -

The intent of this document is to provide maximal guidance with -reasonable restriction. As always, common sense and good taste should -prevail. By this we specifically refer to the established conventions -of the entire Google C++ community, not just your personal preferences -or those of your team. Be skeptical about and reluctant to use -clever or unusual constructs: the absence of a prohibition is not the -same as a license to proceed. Use your judgment, and if you are -unsure, please don't hesitate to ask your project leads to get additional -input.

- -
- - - -

Header Files

- -

In general, every .cc file should have an -associated .h file. There are some common -exceptions, such as unittests and -small .cc files containing just a -main() function.

- -

Correct use of header files can make a huge difference to -the readability, size and performance of your code.

- -

The following rules will guide you through the various -pitfalls of using header files.

- - -

Self-contained Headers

- -
-

Header files should be self-contained and end in .h. Files that -are meant for textual inclusion, but are not headers, should end in -.inc. Separate -inl.h headers are disallowed.

-
- -
-

All header files should be self-contained. In other -words, users and refactoring tools should not have to adhere to special -conditions in order to include the header. Specifically, a -header should have header guards, -should include all other headers it needs, and should not require any -particular symbols to be defined.

- -

There are rare cases where a file is not meant to be self-contained, but -instead is meant to be textually included at a specific point in the code. -Examples are files that need to be included multiple times or -platform-specific extensions that essentially are part of other headers. Such -files should use the file extension .inc.

- -

If a template or inline function is declared in a .h file, -define it in that same file. The definitions of these constructs must -be included into every .cc file that uses them, or the -program may fail to link in some build configurations. Do not move these -definitions to separate -inl.h files.

- -

As an exception, a function template that is explicitly -instantiated for all relevant sets of template arguments, or -that is a private member of a class, may -be defined in the only .cc file that -instantiates the template.

- -
- -

The #define Guard

- -
-

All header files should have #define guards to -prevent multiple inclusion. The format of the symbol name -should be -<PROJECT>_<PATH>_<FILE>_H_.

-
- -
- - - -

To guarantee uniqueness, they should -be based on the full path in a project's source tree. For -example, the file foo/src/bar/baz.h in -project foo should have the following -guard:

- -
#ifndef FOO_BAR_BAZ_H_
-#define FOO_BAR_BAZ_H_
-
-...
-
-#endif  // FOO_BAR_BAZ_H_
-
- - - - -
- -

Forward Declarations

- -
-

Avoid using forward declarations where possible. - Just #include the headers you need.

-
- -
- -
-

A "forward declaration" is a declaration of a class, -function, or template without an associated definition.

-
- -
-
    -
  • Forward declarations can save compile time, as - #includes force the compiler to open - more files and process more input.
    • - -
  • Forward declarations can save on unnecessary - recompilation. #includes can force - your code to be recompiled more often, due to unrelated - changes in the header.
    • -
-
- -
-
    -
  • Forward declarations can hide a dependency, allowing - user code to skip necessary recompilation when headers - change.
    • - -
  • A forward declaration may be broken by subsequent - changes to the library. Forward declarations of functions - and templates can prevent the header owners from making - otherwise-compatible changes to their APIs, such as - widening a parameter type, adding a template parameter - with a default value, or migrating to a new namespace.
    • - -
  • Forward declaring symbols from namespace - std:: yields undefined behavior.
    • - -
  • It can be difficult to determine whether a forward - declaration or a full #include is needed. - Replacing an #include with a forward - declaration can silently change the meaning of - code: - 
          // b.h:
-      struct B {};
-      struct D : B {};
-
-      // good_user.cc:
-      #include "b.h"
-      void f(B*);
-      void f(void*);
-      void test(D* x) { f(x); }  // calls f(B*)
-
    - If the #include was replaced with forward - decls for B and D, - test() would call f(void*). -
    • - -
  • Forward declaring multiple symbols from a header - can be more verbose than simply - #includeing the header.
    • - -
  • Structuring code to enable forward declarations - (e.g. using pointer members instead of object members) - can make the code slower and more complex.
    • - - -
-
- -
-
    -
  • Try to avoid forward declarations of entities - defined in another project.
    • - -
  • When using a function declared in a header file, - always #include that header.
    • - -
  • When using a class template, prefer to - #include its header file.
    • -
- -

Please see Names and Order -of Includes for rules about when to #include a header.

-
- -
- -

Inline Functions

- -
-

Define functions inline only when they are small, say, 10 -lines or less.

-
- -
- -
-

You can declare functions in a way that allows the compiler to expand -them inline rather than calling them through the usual -function call mechanism.

-
- -
-

Inlining a function can generate more efficient object -code, as long as the inlined function is small. Feel free -to inline accessors and mutators, and other short, -performance-critical functions.

-
- -
-

Overuse of inlining can actually make programs slower. -Depending on a function's size, inlining it can cause the -code size to increase or decrease. Inlining a very small -accessor function will usually decrease code size while -inlining a very large function can dramatically increase -code size. On modern processors smaller code usually runs -faster due to better use of the instruction cache.

-
- -
-

A decent rule of thumb is to not inline a function if -it is more than 10 lines long. Beware of destructors, -which are often longer than they appear because of -implicit member- and base-destructor calls!

- -

Another useful rule of thumb: it's typically not cost -effective to inline functions with loops or switch -statements (unless, in the common case, the loop or -switch statement is never executed).

- -

It is important to know that functions are not always -inlined even if they are declared as such; for example, -virtual and recursive functions are not normally inlined. -Usually recursive functions should not be inline. The -main reason for making a virtual function inline is to -place its definition in the class, either for convenience -or to document its behavior, e.g., for accessors and -mutators.

-
- -
- -

Names and Order of Includes

- -
-

Use standard order for readability and to avoid hidden -dependencies: Related header, C library, C++ library, other libraries' -.h, your project's .h.

-
- -
-

-All of a project's header files should be -listed as descendants of the project's source -directory without use of UNIX directory shortcuts -. (the current directory) or .. -(the parent directory). For example, - -google-awesome-project/src/base/logging.h -should be included as:

- -
#include "base/logging.h"
-
- -

In dir/foo.cc or -dir/foo_test.cc, whose main -purpose is to implement or test the stuff in -dir2/foo2.h, order your includes -as follows:

- -
    -
  1. dir2/foo2.h.
    2. - -
  2. C system files.
    3. - -
  3. C++ system files.
    4. - -
  4. Other libraries' .h - files.
    5. - -
  5. - Your project's .h - files.
    6. -
- -

With the preferred ordering, if -dir2/foo2.h omits any necessary -includes, the build of dir/foo.cc -or dir/foo_test.cc will break. -Thus, this rule ensures that build breaks show up first -for the people working on these files, not for innocent -people in other packages.

- -

dir/foo.cc and -dir2/foo2.h are usually in the same -directory (e.g. base/basictypes_test.cc and -base/basictypes.h), but may sometimes be in different -directories too.

- - - -

Within each section the includes should be ordered -alphabetically. Note that older code might not conform to -this rule and should be fixed when convenient.

- -

You should include all the headers that define the symbols you rely -upon, except in the unusual case of forward -declaration. If you rely on symbols from bar.h, -don't count on the fact that you included foo.h which -(currently) includes bar.h: include bar.h -yourself, unless foo.h explicitly demonstrates its intent -to provide you the symbols of bar.h. However, any -includes present in the related header do not need to be included -again in the related cc (i.e., foo.cc can -rely on foo.h's includes).

- -

For example, the includes in - -google-awesome-project/src/foo/internal/fooserver.cc -might look like this:

- - -
#include "foo/server/fooserver.h"
-
-#include <sys/types.h>
-#include <unistd.h>
-#include <hash_map>
-#include <vector>
-
-#include "base/basictypes.h"
-#include "base/commandlineflags.h"
-#include "foo/server/bar.h"
-
- -

Sometimes, system-specific code needs -conditional includes. Such code can put conditional -includes after other includes. Of course, keep your -system-specific code small and localized. Example:

- -
#include "foo/public/fooserver.h"
-
-#include "base/port.h"  // For LANG_CXX11.
-
-#ifdef LANG_CXX11
-#include <initializer_list>
-#endif  // LANG_CXX11
-
- -
- -

Scoping

- -

Namespaces

- -
-

With few exceptions, place code in a namespace. Namespaces -should have unique names based on the project name, and possibly -its path. Unnamed namespaces in .cc files are -encouraged. Do not use using-directives. Do not use -inline namespaces.

-
- -
- -
-

Namespaces subdivide the global scope -into distinct, named scopes, and so are useful for preventing -name collisions in the global scope.

-
- -
- -

Namespaces provide a method for preventing name conflicts -in large programs while allowing most code to use reasonably -short names.

- -

For example, if two different projects have a class -Foo in the global scope, these symbols may -collide at compile time or at runtime. If each project -places their code in a namespace, project1::Foo -and project2::Foo are now distinct symbols that -do not collide, and code within each project's namespace -can continue to refer to Foo without the prefix.

- -

Inline namespaces automatically place their names in -the enclosing scope. Consider the following snippet, for -example:

- -
namespace X {
-inline namespace Y {
-  void foo();
-}
-}
-
- -

The expressions X::Y::foo() and -X::foo() are interchangeable. Inline -namespaces are primarily intended for ABI compatibility -across versions.

-
- -
- -

Namespaces can be confusing, because they complicate -the mechanics of figuring out what definition a name refers -to.

- -

Inline namespaces, in particular, can be confusing -because names aren't actually restricted to the namespace -where they are declared. They are only useful as part of -some larger versioning policy.

- -

Use of unnamed namespaces in header files can easily -cause violations of the C++ One Definition Rule -(ODR).

- -

In some contexts, it's necessary to repeatedly refer to -symbols by their fully-qualified names. For deeply-nested -namespaces, this can add a lot of clutter.

-
- -
- -

Use namespaces according to the policy described -below. Terminate namespaces with comments as shown in the -given examples. See also the rules on -Namespace Names.

-
- -

Unnamed Namespaces

- -
    -
  • -

    Unnamed namespaces are allowed and even encouraged - in .cc files, to avoid link time naming - conflicts:

    - -
    namespace {                           // This is in a .cc file.
-
-// The content of a namespace is not indented.
-//
-// This function is guaranteed not to generate a colliding symbol
-// with other symbols at link time, and is only visible to
-// callers in this .cc file.
-bool UpdateInternals(Frobber* f, int newval) {
-  ...
-}
-
-}  // namespace
-
    -
    • - -
  • Do not use unnamed namespaces in .h - files.
    • -
- -

Named Namespaces

- -

Named namespaces should be used as follows:

- -
    -
  • - -

    Namespaces wrap the entire source file after - includes, - - gflags definitions/declarations - and forward declarations of classes from other namespaces.

    - -
    // In the .h file
-namespace mynamespace {
-
-// All declarations are within the namespace scope.
-// Notice the lack of indentation.
-class MyClass {
- public:
-  ...
-  void Foo();
-};
-
-}  // namespace mynamespace
-
    - -
    // In the .cc file
-namespace mynamespace {
-
-// Definition of functions is within scope of the namespace.
-void MyClass::Foo() {
-  ...
-}
-
-}  // namespace mynamespace
-
    - -

    More complex .cc files might have additional details, - like flags or using-declarations.

    - -
    #include "a.h"
-
-DEFINE_bool(someflag, false, "dummy flag");
-
-using ::foo::bar;
-
-namespace a {
-
-...code for a...         // Code goes against the left margin.
-
-}  // namespace a
-
    -
    • - - - -
  • Do not declare anything in namespace - std, including forward declarations of - standard library classes. Declaring entities in - namespace std is undefined behavior, i.e., - not portable. To declare entities from the standard - library, include the appropriate header file.
    • - -

  • You may not use a using-directive - to make all names from a namespace available.

    - -
    // Forbidden -- This pollutes the namespace.
-using namespace foo;
-
    -
    • - -

  • You may use a using-declaration - anywhere in a .cc file (including in - the global namespace), and in functions, - methods, classes, or within internal namespaces in - .h files.

    - -

    Do not use using-declarations in .h - files except in explicitly marked internal-only - namespaces, because anything imported into a namespace - in a .h file becomes part of the public - API exported by that file.

    - -
    // OK in .cc files.
-// Must be in a function, method, internal namespace, or
-// class in .h files.
-using ::foo::bar;
-
    -
    • - -

  • Namespace aliases are allowed anywhere where - a using-declaration is allowed. In particular, - namespace aliases should not be used at namespace scope - in .h files except in explicitly marked - internal-only namespaces.

    - -
    // Shorten access to some commonly used names in .cc files.
-namespace baz = ::foo::bar::baz;
-
    - -
    // Shorten access to some commonly used names (in a .h file).
-namespace librarian {
-namespace impl {  // Internal, not part of the API.
-namespace sidetable = ::pipeline_diagnostics::sidetable;
-}  // namespace impl
-
-inline void my_inline_function() {
-  // namespace alias local to a function (or method).
-  namespace baz = ::foo::bar::baz;
-  ...
-}
-}  // namespace librarian
-
    - -
  • Do not use inline namespaces.
    • -
- -

Nonmember, Static Member, and Global Functions

- -
-

Prefer placing nonmember functions in a namespace; use completely global -functions rarely. Prefer grouping functions with a namespace instead of -using a class as if it were a namespace. Static methods of a class should -generally be closely related to instances of the class or the class's static -data.

-
- -
- -
-

Nonmember and static member functions can be useful in - some situations. Putting nonmember functions in a - namespace avoids polluting the global namespace.

-
- -
-

Nonmember and static member functions may make more sense -as members of a new class, especially if they access -external resources or have significant dependencies.

-
- -
-

Sometimes it is useful, or even necessary, to define a -function not bound to a class instance. Such a function -can be either a static member or a nonmember function. -Nonmember functions should not depend on external -variables, and should nearly always exist in a namespace. -Rather than creating classes only to group static member -functions which do not share static data, use -namespaces instead. For a header -myproject/foo_bar.h, for example, write

-
namespace myproject {
-namespace foo_bar {
-void Function1();
-void Function2();
-}
-}
-
-

instead of

-
namespace myproject {
-class FooBar {
- public:
-  static void Function1();
-  static void Function2();
-};
-}
-
- -

If you must define a nonmember function and it is only -needed in its .cc file, use an unnamed -namespace or -static linkage (eg static int Foo() -{...}) to limit its scope.

-
- -
- -

Local Variables

- -
-

Place a function's variables in the narrowest scope -possible, and initialize variables in the declaration.

-
- -
- -

C++ allows you to declare variables anywhere in a -function. We encourage you to declare them in as local a -scope as possible, and as close to the first use as -possible. This makes it easier for the reader to find the -declaration and see what type the variable is and what it -was initialized to. In particular, initialization should -be used instead of declaration and assignment, e.g.:

- -
int i;
-i = f();      // Bad -- initialization separate from declaration.
-
- -
int j = g();  // Good -- declaration has initialization.
-
- -
vector<int> v;
-v.push_back(1);  // Prefer initializing using brace initialization.
-v.push_back(2);
-
- -
vector<int> v = {1, 2};  // Good -- v starts initialized.
-
- -

Variables needed for if, while -and for statements should normally be declared -within those statements, so that such variables are confined -to those scopes. E.g.:

- -
while (const char* p = strchr(str, '/')) str = p + 1;
-
- -

There is one caveat: if the variable is an object, its -constructor is invoked every time it enters scope and is -created, and its destructor is invoked every time it goes -out of scope.

- -
// Inefficient implementation:
-for (int i = 0; i < 1000000; ++i) {
-  Foo f;  // My ctor and dtor get called 1000000 times each.
-  f.DoSomething(i);
-}
-
- -

It may be more efficient to declare such a variable -used in a loop outside that loop:

- -
Foo f;  // My ctor and dtor get called once each.
-for (int i = 0; i < 1000000; ++i) {
-  f.DoSomething(i);
-}
-
- -
- -

Static and Global Variables

- -
-

Variables of class type with - static storage duration are forbidden: they cause hard-to-find bugs due - to indeterminate order of construction and destruction. However, such - variables are allowed if they are constexpr: they have no - dynamic initialization or destruction.

-
- -
- -

Objects with static storage duration, including global -variables, static variables, static class member -variables, and function static variables, must be Plain -Old Data (POD): only ints, chars, floats, or pointers, or -arrays/structs of POD.

- -

The order in which class constructors and initializers -for static variables are called is only partially -specified in C++ and can even change from build to build, -which can cause bugs that are difficult to find. -Therefore in addition to banning globals of class type, -we do not allow static POD variables to be initialized -with the result of a function, unless that function (such -as getenv(), or getpid()) does not itself depend on any -other globals. (This prohibition does not apply to a static -variable within function scope, since its initialization -order is well-defined and does not occur until control -passes through its declaration.)

- -

Likewise, global and static variables are destroyed -when the program terminates, regardless of whether the -termination is by returning from main() or -by calling exit(). The order in which -destructors are called is defined to be the reverse of -the order in which the constructors were called. Since -constructor order is indeterminate, so is destructor -order. For example, at program-end time a static variable -might have been destroyed, but code still running -— perhaps in another thread -— tries to access it and fails. Or the -destructor for a static string variable -might be run prior to the destructor for another variable -that contains a reference to that string.

- -

One way to alleviate the destructor problem is to -terminate the program by calling -quick_exit() instead of exit(). -The difference is that quick_exit() does not -invoke destructors and does not invoke any handlers that -were registered by calling atexit(). If you -have a handler that needs to run when a program -terminates via quick_exit() (flushing logs, -for example), you can register it using -at_quick_exit(). (If you have a handler that -needs to run at both exit() and -quick_exit(), you need to register it in -both places.)

- -

As a result we only allow static variables to contain -POD data. This rule completely disallows -vector (use C arrays instead), or -string (use const char []).

- - - -

If you need a static or global -variable of a class type, consider initializing a pointer -(which will never be freed), from either your main() -function or from pthread_once(). Note that this must be a -raw pointer, not a "smart" pointer, since the smart -pointer's destructor will have the order-of-destructor -issue that we are trying to avoid.

- - - - - -
- -

Classes

- -

Classes are the fundamental unit of code in C++. Naturally, -we use them extensively. This section lists the main dos and -don'ts you should follow when writing a class.

- -

Doing Work in Constructors

- -
-

Avoid virtual method calls in constructors, and avoid -initialization that can fail if you can't signal an error.

-
- -
- -
-

It is possible to perform arbitrary initialization in the body -of the constructor.

-
- -
-
    -
  • No need to worry about whether the class has been initialized or - not.
    • - -
  • Objects that are fully initialized by constructor call can - be const and may also be easier to use with standard containers - or algorithms.
    • -
- -
- -
-

The problems with doing work in constructors are:

- -
    -
  • If the work calls virtual functions, these calls - will not get dispatched to the subclass - implementations. Future modification to your class can - quietly introduce this problem even if your class is - not currently subclassed, causing much confusion.
    • - -
  • There is no easy way for constructors to signal errors, short of - crashing the program (not always appropriate) or using exceptions - (which are forbidden).
    • - -
  • If the work fails, we now have an object whose initialization - code failed, so it may be an unusual state requiring a bool - IsValid() state checking mechanism (or similar) which is easy - to forget to call.
    • - -
  • You cannot take address of a constructor, so whatever work is done in - the constructor cannot easily be handed off to, for example, another - thread.
    • -
-
- - -
-

Constructors should never call virtual functions. If appropriate -for your code -, -terminating the program may be an appropriate error handling -response. Otherwise, consider a factory function -or Init() method. Avoid Init() methods on objects with -no other states that affect which public methods may be called -(semi-constructed objects of this form are particularly hard to work -with correctly).

-
- -
- - -

Implicit Conversions

- -
-

Do not define implicit conversions. Use the explicit -keyword for conversion operators and single-argument -constructors.

-
- -
- -
-

Implicit conversions allow an -object of one type (called the source type) to -be used where a different type (called the destination -type) is expected, such as when passing an -int argument to a function that takes a -double parameter.

- -

In addition to the implicit conversions defined by the language, -users can define their own, by adding appropriate members to the -class definition of the source or destination type. An implicit -conversion in the source type is defined by a type conversion operator -named after the destination type (e.g. operator -bool()). An implicit conversion in the destination -type is defined by a converting constructor, which -is a constructor that can take the source type as its only -argument. Note that a multi-parameter constructor can still -be a converting constructor, if all but the first parameter -have default values.

- -

The explicit keyword can be applied to a constructor -or (since C++11) a conversion operator, to ensure that it can only be -used when the destination type is explicit at the point of use, -e.g. with a cast. This applies not only to implicit conversions, but to -C++11's list initialization syntax:

-
class Foo {
-  explicit Foo(int x, double y);
-  ...
-};
-
-void Func(Foo f);
-
-
Func({42, 3.14});  // Error
-
-This kind of code isn't technically an implicit conversion, but the -language treats it as one as far as explicit is concerned. -
- -
-
    -
  • Implicit conversions can make a type more usable and - expressive by eliminating the need to explicitly name a type - when it's obvious.
    • -
  • Implicit conversions can be a simpler alternative to - overloading.
    • -
  • List initialization syntax is a concise and expressive - way of initializing objects.
    • -
-
- -
-
    -
  • Implicit conversions can hide type-mismatch bugs, where the - destination type does not match the user's expectation, or - the user is unaware that any conversion will take place.
    • - -
  • Implicit conversions can make code harder to read, particularly - in the presence of overloading, by making it less obvious what - code is actually getting called.
    • - -
  • Constructors that take a single argument may accidentally - be usable as implicit type conversions, even if they are not - intended to do so.
    • - -
  • When a single-argument constructor is not marked - explicit, there's no reliable way to tell whether - it's intended to define an implicit conversion, or the author - simply forgot to mark it.
    • - -
  • It's not always clear which type should provide the conversion, - and if they both do, the code becomes ambiguous.
    • - -
  • List initialization can suffer from the same problems if - the destination type is implicit, particularly if the - list has only a single element.
    • -
-
- -
-

Type conversion operators, and constructors that are -callable with a single argument, must be marked -explicit in the class definition. As an -exception, copy and move constructors should not be -explicit, since they do not perform type -conversion. Implicit conversions can sometimes be necessary and -appropriate for types that are designed to transparently wrap other -types. In that case, contact -your project leads to request -a waiver of this rule.

- -

Constructors that cannot be called with a single argument -should usually omit explicit. Constructors that -take a single std::initializer_list parameter should -also omit explicit, in order to support copy-initialization -(e.g. MyType m = {1, 2};).

-
- -
- -

Copyable and Movable Types

- -
-

Support copying and/or moving if it makes sense for your type. -Otherwise, disable the implicitly generated special -functions that perform copies and moves.

-
- -
- -
-

A copyable type allows its objects to be initialized or assigned -from any other object of the same type, without changing the value of the source. -For user-defined types, the copy behavior is defined by the copy -constructor and the copy-assignment operator. -string is an example of a copyable type.

- -

A movable type is one that can be initialized and assigned -from temporaries (all copyable types are therefore movable). -std::unique_ptr<int> is an example of a movable but not -copyable type. For user-defined types, the move behavior is defined by the move -constructor and the move-assignment operator.

- -

The copy/move constructors can be implicitly invoked by the compiler -in some situations, e.g. when passing objects by value.

-
- -
-

Objects of copyable and movable types can be passed and returned -by value, which makes APIs simpler, safer, and more general. -Unlike when passing pointers or references, there's no risk of -confusion over ownership, lifetime, mutability, and similar -issues, and no need to specify them in the contract. It also -prevents non-local interactions between the client and the -implementation, which makes them easier to understand and -maintain. Such objects can be used with generic -APIs that require pass-by-value, such as most containers.

- -

Copy/move constructors and assignment operators are usually -easier to define correctly than alternatives -like Clone(), CopyFrom() or Swap(), -because they can be generated by the compiler, either implicitly or -with = default. They are concise, and ensure -that all data members are copied. Copy and move -constructors are also generally more efficient, because they don't -require heap allocation or separate initialization and assignment -steps, and they're eligible for optimizations such as - - -copy elision.

- -

Move operations allow the implicit and efficient transfer of -resources out of rvalue objects. This allows a plainer coding style -in some cases.

-
- -
-

Many types do not need to be copyable, and providing copy -operations for them can be confusing, nonsensical, or outright -incorrect. Copy/assigment operations for base class types are -hazardous, because use of them can lead to -object -slicing. Defaulted or carelessly-implemented copy operations -can be incorrect, and the resulting bugs can be confusing and -difficult to diagnose.

- -

Copy constructors are invoked implicitly, which makes the -invocation easy to miss. This may cause confusion, particularly -for programmers used to languages where pass-by-reference is -conventional or mandatory. It may also encourage excessive -copying, which can cause performance problems.

- - -
- -
- -

Make your type copyable/movable if it will be useful, and if it makes sense -in the context of the rest of the API. As a rule of thumb, if the behavior -(including computational complexity) of a copy isn't immediately obvious to -users of your type, your type shouldn't be copyable. If you define a copy or -move constructor, define the corresponding assignment operator, and vice-versa. -If your type is copyable, do not define move operations unless they are -significantly more efficient than the corresponding copy operations. If your -type is not copyable, but the correctness of a move is obvious to users of the -type, you may make the type move-only by defining both of the move operations. -

- -

If your type provides copy operations, it is recommended that you design -your class so that the default implementation of those operations is correct -and that you explicitly define them with = default. Remember to -review the correctness of any defaulted operations as you would any other -code.

- -
class Foo {  // Copyable and movable type.
- public:
-  Foo(Foo&& other) = default;
-  Foo(const Foo& other) = default;
-  Foo& operator=(Foo&& other) = default;
-  Foo& operator=(const Foo& other) = default;
-
- private:
-  string field_;
-};
-
- -
class Foo {
- public:
-  Foo(Foo&& other) : field_(other.field) {}
-  // Bad, defines only move constructor, but not operator=.
-
- private:
-  Field field_;
-};
-
- -

Due to the risk of slicing, avoid providing an assignment -operator or public copy/move constructor for a class that's -intended to be derived from (and avoid deriving from a class -with such members). If your base class needs to be -copyable, provide a public virtual Clone() -method, and a protected copy constructor that derived classes -can use to implement it.

- -

If you do not want to support copy/move operations on -your type, explicitly disable them using = delete or -whatever -other mechanism your project uses. - -

-
- -

Delegating and Inheriting Constructors

- -
-

Use delegating and inheriting -constructors when they reduce code duplication.

-
- -
- -
- -

Delegating and inheriting constructors are two -different features, both introduced in C++11, for -reducing code duplication in constructors. Delegating -constructors allow one of a class's constructors to -forward work to one of the class's other constructors, -using a special variant of the initialization list -syntax. For example:

- -
X::X(const string& name) : name_(name) {
-  ...
-}
-
-X::X() : X("") {}
-
- -

Inheriting constructors allow a derived class to have -its base class's constructors available directly, just as -with any of the base class's other member functions, -instead of having to redeclare them. This is especially -useful if the base has multiple constructors. For -example:

- -
class Base {
- public:
-  Base();
-  Base(int n);
-  Base(const string& s);
-  ...
-};
-
-class Derived : public Base {
- public:
-  using Base::Base;  // Base's constructors are redeclared here.
-};
-
- -

This is especially useful when Derived's -constructors don't have to do anything more than calling -Base's constructors.

-
- -
-

Delegating and inheriting constructors reduce -verbosity and boilerplate, which can improve -readability.

- -

Delegating constructors are familiar to Java -programmers.

-
- -
-

It's possible to approximate the behavior of -delegating constructors by using a helper function.

- -

Inheriting constructors may be confusing if a derived -class introduces new member variables, since the base -class constructor doesn't know about them.

-
- -
-

Use delegating and inheriting constructors when they reduce -boilerplate and improve readability. -Be cautious about inheriting constructors when your derived class has -new member variables. Inheriting constructors may still be appropriate -in that case if you can use in-class member initialization -for the derived class's member variables.

-
- -
- -

Structs vs. Classes

- -
-

Use a struct only for passive objects that - carry data; everything else is a class.

-
- -
- -

The struct and class -keywords behave almost identically in C++. We add our own -semantic meanings to each keyword, so you should use the -appropriate keyword for the data-type you're -defining.

- -

structs should be used for passive -objects that carry data, and may have associated -constants, but lack any functionality other than -access/setting the data members. The accessing/setting of -fields is done by directly accessing the fields rather -than through method invocations. Methods should not -provide behavior but should only be used to set up the -data members, e.g., constructor, destructor, -Initialize(), Reset(), -Validate().

- -

If more functionality is required, a -class is more appropriate. If in doubt, make -it a class.

- -

For consistency with STL, you can use -struct instead of class for -functors and traits.

- -

Note that member variables in structs and classes have -different naming rules.

- -
- -

Inheritance

- -
-

Composition is often more appropriate than inheritance. -When using inheritance, make it public.

-
- -
- -
-

When a sub-class -inherits from a base class, it includes the definitions -of all the data and operations that the parent base class -defines. In practice, inheritance is used in two major -ways in C++: implementation inheritance, in which actual -code is inherited by the child, and -interface inheritance, in which -only method names are inherited.

-
- -
-

Implementation inheritance reduces code size by re-using -the base class code as it specializes an existing type. -Because inheritance is a compile-time declaration, you -and the compiler can understand the operation and detect -errors. Interface inheritance can be used to -programmatically enforce that a class expose a particular -API. Again, the compiler can detect errors, in this case, -when a class does not define a necessary method of the -API.

-
- -
-

For implementation inheritance, because the code -implementing a sub-class is spread between the base and -the sub-class, it can be more difficult to understand an -implementation. The sub-class cannot override functions -that are not virtual, so the sub-class cannot change -implementation. The base class may also define some data -members, so that specifies physical layout of the base -class.

-
- -
- -

All inheritance should be public. If you -want to do private inheritance, you should be including -an instance of the base class as a member instead.

- -

Do not overuse implementation inheritance. Composition -is often more appropriate. Try to restrict use of -inheritance to the "is-a" case: Bar -subclasses Foo if it can reasonably be said -that Bar "is a kind of" -Foo.

- -

Make your destructor virtual if -necessary. If your class has virtual methods, its -destructor should be virtual.

- -

Limit the use of protected to those -member functions that might need to be accessed from -subclasses. Note that data -members should be private.

- -

Explicitly annotate overrides of virtual functions -or virtual destructors with an override -or (less frequently) final specifier. -Older (pre-C++11) code will use the -virtual keyword as an inferior -alternative annotation. For clarity, use exactly one of -override, final, or -virtual when declaring an override. -Rationale: A function or destructor marked -override or final that is -not an override of a base class virtual function will -not compile, and this helps catch common errors. The -specifiers serve as documentation; if no specifier is -present, the reader has to check all ancestors of the -class in question to determine if the function or -destructor is virtual or not.

-
- -
- -

Multiple Inheritance

- -
-

Only very rarely is multiple implementation inheritance -actually useful. We allow multiple inheritance only when at -most one of the base classes has an implementation; all -other base classes must be pure -interface classes tagged with the -Interface suffix.

-
- -
- -
-

Multiple inheritance allows a sub-class to have more than -one base class. We distinguish between base classes that are -pure interfaces and those that have an -implementation.

-
- -
-

Multiple implementation inheritance may let you re-use -even more code than single inheritance (see Inheritance).

-
- -
-

Only very rarely is multiple implementation -inheritance actually useful. When multiple implementation -inheritance seems like the solution, you can usually find -a different, more explicit, and cleaner solution.

-
- -
-

Multiple inheritance is allowed only when all -superclasses, with the possible exception of the first one, -are pure interfaces. In order to -ensure that they remain pure interfaces, they must end with -the Interface suffix.

-
- -
-

There is an exception to -this rule on Windows.

-
- -
- -

Interfaces

- -
-

Classes that satisfy certain conditions are allowed, but -not required, to end with an Interface suffix.

-
- -
- -
-

A class is a pure interface if it meets the following -requirements:

- -
    -
  • It has only public pure virtual ("= - 0") methods and static methods (but see below - for destructor).
    • - -
  • It may not have non-static data members.
    • - -
  • It need not have any constructors defined. If a - constructor is provided, it must take no arguments and - it must be protected.
    • - -
  • If it is a subclass, it may only be derived from - classes that satisfy these conditions and are tagged - with the Interface suffix.
    • -
- -

An interface class can never be directly instantiated -because of the pure virtual method(s) it declares. To -make sure all implementations of the interface can be -destroyed correctly, the interface must also declare a -virtual destructor (in an exception to the first rule, -this should not be pure). See Stroustrup, The C++ -Programming Language, 3rd edition, section 12.4 -for details.

-
- -
-

Tagging a class with the Interface suffix -lets others know that they must not add implemented -methods or non static data members. This is particularly -important in the case of multiple inheritance. -Additionally, the interface concept is already -well-understood by Java programmers.

-
- -
-

The Interface suffix lengthens the class -name, which can make it harder to read and understand. -Also, the interface property may be considered an -implementation detail that shouldn't be exposed to -clients.

-
- -
-

A class may end -with Interface only if it meets the above -requirements. We do not require the converse, however: -classes that meet the above requirements are not required -to end with Interface.

-
- -
- -

Operator Overloading

- -
-

Overload operators judiciously. Do not create user-defined literals.

-
- -
- -
-

C++ permits user code to -declare -overloaded versions of the built-in operators using the -operator keyword, so long as one of the parameters -is a user-defined type. The operator keyword also -permits user code to define new kinds of literals using -operator"", and to define type-conversion functions -such as operator bool().

-
- -
-

Operator overloading can make code more concise and -intuitive by enabling user-defined types to behave the same -as built-in types. Overloaded operators are the idiomatic names -for certain operations (e.g. ==, <, -=, and <<), and adhering to -those conventions can make user-defined types more readable -and enable them to interoperate with libraries that expect -those names.

- -

User-defined literals are a very concise notation for -creating objects of user-defined types.

-
- -
-
    -
  • Providing a correct, consistent, and unsurprising - set of operator overloads requires some care, and failure - to do so can lead to confusion and bugs.
    • - -
  • Overuse of operators can lead to obfuscated code, - particularly if the overloaded operator's semantics - don't follow convention.
    • - -
  • The hazards of function overloading apply just as - much to operator overloading, if not more so.
    • - -
  • Operator overloads can fool our intuition into - thinking that expensive operations are cheap, built-in - operations.
    • - -
  • Finding the call sites for overloaded operators may - requre a search tool that's aware of C++ syntax, rather - than e.g. grep.
    • - -
  • If you get the argument type of an overloaded operator - wrong, you may get a different overload rather than a - compiler error. For example, foo < bar - may do one thing, while &foo < &bar - does something totally different.
    • - -
  • Certain operator overloads are inherently hazardous. - Overloading unary & can cause the same - code to have different meanings depending on whether - the overload declaration is visible. Overloads of - &&, ||, and , - (comma) cannot match the evaluation-order semantics of the - built-in operators.
    • - -
  • Operators are often defined outside the class, - so there's a risk of different files introducing - different definitions of the same operator. If both - definitions are linked into the same binary, this results - in undefined behavior, which can manifest as subtle - run-time bugs.
    • - -
  • User-defined literals allow the creation of new - syntactic forms that are unfamiliar even to experienced C++ - programmers.
    • -
-
- -
-

Define overloaded operators only if their meaning is -obvious, unsurprising, and consistent with the corresponding -built-in operators. For example, use | as a -bitwise- or logical-or, not as a shell-style pipe.

- -

Define operators only on your own types. More precisely, -define them in the same headers, .cc files, and namespaces -as the types they operate on. That way, the operators are available -wherever the type is, minimizing the risk of multiple -definitions. If possible, avoid defining operators as templates, -because they must satisfy this rule for any possible template -arguments. If you define an operator, also define -any related operators that make sense, and make sure they -are defined consistently. For example, if you overload -<, overload all the comparison operators, -and make sure < and > never -return true for the same arguments.

- -

Prefer to define non-modifying binary operators as -non-member functions. If a binary operator is defined as a -class member, implicit conversions will apply to the -right-hand argument, but not the left-hand one. It will -confuse your users if a < b compiles but -b < a doesn't.

- -

Don't go out of your way to avoid defining operator -overloads. For example, prefer to define ==, -=, and <<, rather than -Equals(), CopyFrom(), and -PrintTo(). Conversely, don't define -operator overloads just because other libraries expect -them. For example, if your type doesn't have a natural -ordering, but you want to store it in a std::set, -use a custom comparator rather than overloading -<.

- -

Do not overload &&, ||, -, (comma), or unary &. Do not overload -operator"", i.e. do not introduce user-defined -literals.

- -

Type conversion operators are covered in the section on -implicit conversions. -The = operator is covered in the section on -copy constructors. Overloading -<< for use with streams is covered in the -section on streams. See also the rules on -function overloading, which -apply to operator overloading as well.

-
- -
- -

Access Control

- -
-

Make data members private, unless they are -static const (and follow the -naming convention for constants). For technical -reasons, we allow data members of a test fixture class to -be protected when using - - -Google -Test).

-
- -

Declaration Order

- -
-

Use the specified order of declarations within a class: -public: before private:, methods -before data members (variables), etc.

-
- -
- -

Your class definition should start with its -public: section, followed by its -protected: section and then its -private: section. If any of these sections -are empty, omit them.

- -

Within each section, the declarations generally should -be in the following order:

- -
    -
  • Typedefs and Enums
    • - -
  • Constants (static const data - members)
    • - -
  • Constructors
    • - -
  • Destructor
    • - -
  • Methods, including static methods
    • - -
  • Data Members (except static const data - members)
    • -
- -

If copying and assignment are disabled with a macro such as -DISALLOW_COPY_AND_ASSIGN, it should be -at the end of the private: section, and should be -the last thing in the class. See -Copyable and Movable Types.

- -

Do not put large method definitions inline in the -class definition. Usually, only trivial or -performance-critical, and very short, methods may be -defined inline. See Inline -Functions for more details.

- -
- -

Functions

- -

Parameter Ordering

- -
-

When defining a function, parameter order is: inputs, then -outputs.

-
- -
-

Parameters to C/C++ functions are either input to the -function, output from the function, or both. Input -parameters are usually values or const -references, while output and input/output parameters will -be non-const pointers. When ordering -function parameters, put all input-only parameters before -any output parameters. In particular, do not add new -parameters to the end of the function just because they -are new; place new input-only parameters before the -output parameters.

- -

This is not a hard-and-fast rule. Parameters that are -both input and output (often classes/structs) muddy the -waters, and, as always, consistency with related -functions may require you to bend the rule.

- -
- -

Write Short Functions

- -
-

Prefer small and focused functions.

-
- -
-

We recognize that long functions are sometimes -appropriate, so no hard limit is placed on functions -length. If a function exceeds about 40 lines, think about -whether it can be broken up without harming the structure -of the program.

- -

Even if your long function works perfectly now, -someone modifying it in a few months may add new -behavior. This could result in bugs that are hard to -find. Keeping your functions short and simple makes it -easier for other people to read and modify your code.

- -

You could find long and complicated functions when -working with -some code. Do not be -intimidated by modifying existing code: if working with -such a function proves to be difficult, you find that -errors are hard to debug, or you want to use a piece of -it in several different contexts, consider breaking up -the function into smaller and more manageable pieces.

- -
- -

Reference Arguments

- -
-

All parameters passed by reference must be labeled -const.

-
- -
- -
-

In C, if a -function needs to modify a variable, the parameter must -use a pointer, eg int foo(int *pval). In -C++, the function can alternatively declare a reference -parameter: int foo(int &val).

-
- -
-

Defining a parameter as reference avoids ugly code like -(*pval)++. Necessary for some applications -like copy constructors. Makes it clear, unlike with -pointers, that a null pointer is not a possible -value.

-
- -
-

References can be confusing, as they have value syntax -but pointer semantics.

-
- -
-

Within function parameter lists all references must be -const:

- -
void Foo(const string &in, string *out);
-
- -

In fact it is a very strong convention in Google code -that input arguments are values or const -references while output arguments are pointers. Input -parameters may be const pointers, but we -never allow non-const reference parameters -except when required by convention, e.g., -swap().

- -

However, there are some instances where using -const T* is preferable to const -T& for input parameters. For example:

- -
    -
  • You want to pass in a null pointer.
    • - -
  • The function saves a pointer or reference to the - input.
    • -
- -

Remember that most of the time input -parameters are going to be specified as const -T&. Using const T* instead -communicates to the reader that the input is somehow -treated differently. So if you choose const -T* rather than const T&, do so -for a concrete reason; otherwise it will likely confuse -readers by making them look for an explanation that -doesn't exist.

-
- -
- -

Function Overloading

- -
-

Use overloaded functions (including constructors) only if a -reader looking at a call site can get a good idea of what -is happening without having to first figure out exactly -which overload is being called.

-
- -
- -
-

You may write a function that takes a const -string& and overload it with another that -takes const char*.

- -
class MyClass {
- public:
-  void Analyze(const string &text);
-  void Analyze(const char *text, size_t textlen);
-};
-
-
- -
-

Overloading can make code more intuitive by allowing an -identically-named function to take different arguments. -It may be necessary for templatized code, and it can be -convenient for Visitors.

-
- -
-

If a function is overloaded by the argument types alone, -a reader may have to understand C++'s complex matching -rules in order to tell what's going on. Also many people -are confused by the semantics of inheritance if a derived -class overrides only some of the variants of a -function.

-
- -
-

If you want to overload a function, consider qualifying -the name with some information about the arguments, e.g., -AppendString(), AppendInt() -rather than just Append(). If you are -overloading a function to support variable number of -arguments of the same type, consider making it take a -vector so that the user can use an -initializer list - to specify the arguments.

-
- -
- -

Default Arguments

- -
-

We do not allow default function parameters, except in -limited situations as explained below. Simulate them with -function overloading instead, if appropriate.

-
- -
- -
-

Often you have a function that uses default values, but -occasionally you want to override the defaults. Default -parameters allow an easy way to do this without having to -define many functions for the rare exceptions. Compared -to overloading the function, default arguments have a -cleaner syntax, with less boilerplate and a clearer -distinction between 'required' and 'optional' -arguments.

-
- -
-

Function pointers are confusing in the presence of -default arguments, since the function signature often -doesn't match the call signature. Adding a default -argument to an existing function changes its type, which -can cause problems with code taking its address. Adding -function overloads avoids these problems. In addition, -default parameters may result in bulkier code since they -are replicated at every call-site -- as opposed to -overloaded functions, where "the default" appears only in -the function definition.

-
- -
-

While the cons above are not that onerous, they still -outweigh the (small) benefits of default arguments over -function overloading. So except as described below, we -require all arguments to be explicitly specified.

- -

One specific exception is when the function is a -static function (or in an unnamed namespace) in a .cc -file. In this case, the cons don't apply since the -function's use is so localized.

- -

In addition, default function parameters are allowed in -constructors. Most of the cons listed above don't apply to -constructors because it's impossible to take their address.

- -

Another specific exception is when default arguments -are used to simulate variable-length argument lists.

- - - 
// Support up to 4 params by using a default empty AlphaNum.
-string StrCat(const AlphaNum &a,
-              const AlphaNum &b = gEmptyAlphaNum,
-              const AlphaNum &c = gEmptyAlphaNum,
-              const AlphaNum &d = gEmptyAlphaNum);
-
-
- -
- -

Trailing Return Type Syntax

-
-

Use trailing return types only where using the ordinary syntax (leading - return types) is impractical or much less readable.

-
- -
-

C++ allows two different forms of function declarations. In the older - form, the return type appears before the function name. For example:

-
int foo(int x);
-
-

The new form, introduced in C++11, uses the auto - keyword before the function name and a trailing return type after - the argument list. For example, the declaration above could - equivalently be written:

-
auto foo(int x) -> int;
-
-

The trailing return type is in the function's scope. This doesn't - make a difference for a simple case like int but it matters - for more complicated cases, like types declared in class scope or - types written in terms of the function parameters.

-
- -
-
-

Trailing return types are the only way to explicitly specify the - return type of a lambda expression. - In some cases the compiler is able to deduce a lambda's return type, - but not in all cases. Even when the compiler can deduce it automatically, - sometimes specifying it explicitly would be clearer for readers. -

-

Sometimes it's easier and more readable to specify a return type - after the function's parameter list has already appeared. This is - particularly true when the return type depends on template parameters. - For example:

- 
template <class T, class U> auto add(T t, U u) -> decltype(t + u);
- versus - 
template <class T, class U> decltype(declval<T&>() + declval<U&>()) add(T t, U u);
-
- -
-

Trailing return type syntax is relatively new and it has no - analogue in C++-like languages like C and Java, so some readers may - find it unfamiliar.

-

Existing code bases have an enormous number of function - declarations that aren't going to get changed to use the new syntax, - so the realistic choices are using the old syntax only or using a mixture - of the two. Using a single version is better for uniformity of style.

-
- -
-

In most cases, continue to use the older style of function - declaration where the return type goes before the function name. - Use the new trailing-return-type form only in cases where it's - required (such as lambdas) or where, by putting the type after the - function's parameter list, it allows you to write the type in a much - more readable way. The latter case should be rare; it's mostly an - issue in fairly complicated template code, which is - discouraged in most cases.

- -
-
- -

Google-Specific Magic

- - - -

There are various tricks and utilities that -we use to make C++ code more robust, and various ways we use -C++ that may differ from what you see elsewhere.

- - - -

Ownership and Smart Pointers

- -
-

Prefer to have single, fixed owners for dynamically -allocated objects. Prefer to transfer ownership with smart -pointers.

-
- -
- -
-

"Ownership" is a bookkeeping technique for managing -dynamically allocated memory (and other resources). The -owner of a dynamically allocated object is an object or -function that is responsible for ensuring that it is -deleted when no longer needed. Ownership can sometimes be -shared, in which case the last owner is typically -responsible for deleting it. Even when ownership is not -shared, it can be transferred from one piece of code to -another.

- -

"Smart" pointers are classes that act like pointers, -e.g. by overloading the * and --> operators. Some smart pointer types -can be used to automate ownership bookkeeping, to ensure -these responsibilities are met. - -std::unique_ptr is a smart pointer type -introduced in C++11, which expresses exclusive ownership -of a dynamically allocated object; the object is deleted -when the std::unique_ptr goes out of scope. -It cannot be copied, but can be moved to -represent ownership transfer. - -std::shared_ptr is a smart pointer type -that expresses shared ownership of -a dynamically allocated object. std::shared_ptrs -can be copied; ownership of the object is shared among -all copies, and the object is deleted when the last -std::shared_ptr is destroyed.

-
- -
-
    -
  • It's virtually impossible to manage dynamically - allocated memory without some sort of ownership - logic.
    • - -
  • Transferring ownership of an object can be cheaper - than copying it (if copying it is even possible).
    • - -
  • Transferring ownership can be simpler than - 'borrowing' a pointer or reference, because it reduces - the need to coordinate the lifetime of the object - between the two users.
    • - -
  • Smart pointers can improve readability by making - ownership logic explicit, self-documenting, and - unambiguous.
    • - -
  • Smart pointers can eliminate manual ownership - bookkeeping, simplifying the code and ruling out large - classes of errors.
    • - -
  • For const objects, shared ownership can be a simple - and efficient alternative to deep copying.
    • -
-
- -
-
    -
  • Ownership must be represented and transferred via - pointers (whether smart or plain). Pointer semantics - are more complicated than value semantics, especially - in APIs: you have to worry not just about ownership, - but also aliasing, lifetime, and mutability, among - other issues.
    • - -
  • The performance costs of value semantics are often - overestimated, so the performance benefits of ownership - transfer might not justify the readability and - complexity costs.
    • - -
  • APIs that transfer ownership force their clients - into a single memory management model.
    • - -
  • Code using smart pointers is less explicit about - where the resource releases take place.
    • - -
  • std::unique_ptr expresses ownership - transfer using C++11's move semantics, which are - relatively new and may confuse some programmers.
    • - -
  • Shared ownership can be a tempting alternative to - careful ownership design, obfuscating the design of a - system.
    • - -
  • Shared ownership requires explicit bookkeeping at - run-time, which can be costly.
    • - -
  • In some cases (e.g. cyclic references), objects - with shared ownership may never be deleted.
    • - -
  • Smart pointers are not perfect substitutes for - plain pointers.
    • -
-
- -
-

If dynamic allocation is necessary, prefer to keep -ownership with the code that allocated it. If other code -needs access to the object, consider passing it a copy, -or passing a pointer or reference without transferring -ownership. Prefer to use std::unique_ptr to -make ownership transfer explicit. For example:

- -
std::unique_ptr<Foo> FooFactory();
-void FooConsumer(std::unique_ptr<Foo> ptr);
-
- - - -

Do not design your code to use shared ownership -without a very good reason. One such reason is to avoid -expensive copy operations, but you should only do this if -the performance benefits are significant, and the -underlying object is immutable (i.e. -std::shared_ptr<const Foo>). If you -do use shared ownership, prefer to use -std::shared_ptr.

- -

Do not use scoped_ptr in new code unless -you need to be compatible with older versions of C++. -Never use std::auto_ptr. Instead, use -std::unique_ptr.

- - -
- -
- -

cpplint

- -
-

Use cpplint.py -to detect style errors.

-
- -
- -

cpplint.py -is a tool that reads a source file and identifies many -style errors. It is not perfect, and has both false -positives and false negatives, but it is still a valuable -tool. False positives can be ignored by putting // -NOLINT at the end of the line or -// NOLINTNEXTLINE in the previous line.

- - - -

Some projects have instructions on -how to run cpplint.py from their project -tools. If the project you are contributing to does not, -you can download - -cpplint.py separately.

- -
- - - -

Other C++ Features

- -

Rvalue References

- -
-

Use rvalue references only to define move constructors and move assignment -operators, or for perfect forwarding. -

-
- -
- -
-

Rvalue references -are a type of reference that can only bind to temporary -objects. The syntax is similar to traditional reference -syntax. For example, void f(string&& -s); declares a function whose argument is an -rvalue reference to a string.

-
- -
-
    -
  • Defining a move constructor (a constructor taking - an rvalue reference to the class type) makes it - possible to move a value instead of copying it. If - v1 is a vector<string>, - for example, then auto v2(std::move(v1)) - will probably just result in some simple pointer - manipulation instead of copying a large amount of data. - In some cases this can result in a major performance - improvement.
    • - -
  • Rvalue references make it possible to write a - generic function wrapper that forwards its arguments to - another function, and works whether or not its - arguments are temporary objects. (This is sometimes called - "perfect forwarding".)
    • - -
  • Rvalue references make it possible to implement - types that are movable but not copyable, which can be - useful for types that have no sensible definition of - copying but where you might still want to pass them as - function arguments, put them in containers, etc.
    • - -
  • std::move is necessary to make - effective use of some standard-library types, such as - std::unique_ptr.
    • -
-
- -
-
    -
  • Rvalue references are a relatively new feature - (introduced as part of C++11), and not yet widely - understood. Rules like reference collapsing, and - automatic synthesis of move constructors, are - complicated.
    • -
-
- -
-

Use rvalue references only to define move constructors and move assignment - operators (as described in Copyable and - Movable Types) and, in conjunction with std::forward, -to support perfect forwarding. You may use std::move to express -moving a value from one object to another rather than copying it.

-
- -
- -

- Variable-Length Arrays and alloca()

- -
-

We do not allow variable-length arrays or -alloca().

-
- -
- -
-

Variable-length arrays have natural-looking syntax. Both -variable-length arrays and alloca() are very -efficient.

-
- -
-

Variable-length arrays and alloca are not part of -Standard C++. More importantly, they allocate a -data-dependent amount of stack space that can trigger -difficult-to-find memory overwriting bugs: "It ran fine -on my machine, but dies mysteriously in production".

-
- -
- - -

Use a safe allocator instead, such as -vector or -std::unique_ptr<T[]>.

-
- -
- -

Friends

- -
-

We allow use of friend classes and functions, -within reason.

-
- -
- -

Friends should usually be defined in the same file so -that the reader does not have to look in another file to -find uses of the private members of a class. A common use -of friend is to have a -FooBuilder class be a friend of -Foo so that it can construct the inner state -of Foo correctly, without exposing this -state to the world. In some cases it may be useful to -make a unittest class a friend of the class it tests.

- -

Friends extend, but do not break, the encapsulation -boundary of a class. In some cases this is better than -making a member public when you want to give only one -other class access to it. However, most classes should -interact with other classes solely through their public -members.

- -
- -

Exceptions

- -
-

We do not use C++ exceptions.

-
- -
- -
-
    -
  • Exceptions allow higher levels of an application to - decide how to handle "can't happen" failures in deeply - nested functions, without the obscuring and error-prone - bookkeeping of error codes.
    • - - - -
  • Exceptions are used by most other - modern languages. Using them in C++ would make it more - consistent with Python, Java, and the C++ that others - are familiar with.
    • - -
  • Some third-party C++ libraries use exceptions, and - turning them off internally makes it harder to - integrate with those libraries.
    • - -
  • Exceptions are the only way for a constructor to - fail. We can simulate this with a factory function or - an Init() method, but these require heap - allocation or a new "invalid" state, respectively.
    • - -
  • Exceptions are really handy in testing - frameworks.
    • -
-
- -
-
    -
  • When you add a throw statement to an - existing function, you must examine all of its - transitive callers. Either they must make at least the - basic exception safety guarantee, or they must never - catch the exception and be happy with the program - terminating as a result. For instance, if - f() calls g() calls - h(), and h throws an - exception that f catches, g - has to be careful or it may not clean up properly.
    • - -
  • More generally, exceptions make the control flow of - programs difficult to evaluate by looking at code: - functions may return in places you don't expect. This - causes maintainability and debugging difficulties. You - can minimize this cost via some rules on how and where - exceptions can be used, but at the cost of more that a - developer needs to know and understand.
    • - -
  • Exception safety requires both RAII and different - coding practices. Lots of supporting machinery is - needed to make writing correct exception-safe code - easy. Further, to avoid requiring readers to understand - the entire call graph, exception-safe code must isolate - logic that writes to persistent state into a "commit" - phase. This will have both benefits and costs (perhaps - where you're forced to obfuscate code to isolate the - commit). Allowing exceptions would force us to always - pay those costs even when they're not worth it.
    • - -
  • Turning on exceptions adds data to each binary - produced, increasing compile time (probably slightly) - and possibly increasing address space pressure. -
    • - -
  • The availability of exceptions may encourage - developers to throw them when they are not appropriate - or recover from them when it's not safe to do so. For - example, invalid user input should not cause exceptions - to be thrown. We would need to make the style guide - even longer to document these restrictions!
    • -
-
- -
-

On their face, the benefits of using exceptions -outweigh the costs, especially in new projects. However, -for existing code, the introduction of exceptions has -implications on all dependent code. If exceptions can be -propagated beyond a new project, it also becomes -problematic to integrate the new project into existing -exception-free code. Because most existing C++ code at -Google is not prepared to deal with exceptions, it is -comparatively difficult to adopt new code that generates -exceptions.

- -

Given that Google's existing code is not -exception-tolerant, the costs of using exceptions are -somewhat greater than the costs in a new project. The -conversion process would be slow and error-prone. We -don't believe that the available alternatives to -exceptions, such as error codes and assertions, introduce -a significant burden.

- -

Our advice against using exceptions is not predicated -on philosophical or moral grounds, but practical ones. - Because we'd like to use our open-source -projects at Google and it's difficult to do so if those -projects use exceptions, we need to advise against -exceptions in Google open-source projects as well. -Things would probably be different if we had to do it all -over again from scratch.

- -

This prohibition also applies to the exception-related -features added in C++11, such as noexcept, -std::exception_ptr, and -std::nested_exception.

- -

There is an exception to -this rule (no pun intended) for Windows code.

-
- -
- -

Run-Time Type -Information (RTTI)

- -
-

Avoid using Run Time Type Information (RTTI).

-
- -
- -
-

RTTI allows a -programmer to query the C++ class of an object at run -time. This is done by use of typeid or -dynamic_cast.

-
- -
-

Querying the type of an object at run-time frequently -means a design problem. Needing to know the type of an -object at runtime is often an indication that the design -of your class hierarchy is flawed.

- -

Undisciplined use of RTTI makes code hard to maintain. -It can lead to type-based decision trees or switch -statements scattered throughout the code, all of which -must be examined when making further changes.

-
- -
-

The standard alternatives to RTTI (described below) -require modification or redesign of the class hierarchy -in question. Sometimes such modifications are infeasible -or undesirable, particularly in widely-used or mature -code.

- -

RTTI can be useful in some unit tests. For example, it -is useful in tests of factory classes where the test has -to verify that a newly created object has the expected -dynamic type. It is also useful in managing the -relationship between objects and their mocks.

- -

RTTI is useful when considering multiple abstract -objects. Consider

- -
bool Base::Equal(Base* other) = 0;
-bool Derived::Equal(Base* other) {
-  Derived* that = dynamic_cast<Derived*>(other);
-  if (that == NULL)
-    return false;
-  ...
-}
-
-
- -
-

RTTI has legitimate uses but is prone to abuse, so you -must be careful when using it. You may use it freely in -unittests, but avoid it when possible in other code. In -particular, think twice before using RTTI in new code. If -you find yourself needing to write code that behaves -differently based on the class of an object, consider one -of the following alternatives to querying the type:

- -
    -
  • Virtual methods are the preferred way of executing - different code paths depending on a specific subclass - type. This puts the work within the object itself.
    • - -
  • If the work belongs outside the object and instead - in some processing code, consider a double-dispatch - solution, such as the Visitor design pattern. This - allows a facility outside the object itself to - determine the type of class using the built-in type - system.
    • -
- -

When the logic of a program guarantees that a given -instance of a base class is in fact an instance of a -particular derived class, then a -dynamic_cast may be used freely on the -object. Usually one -can use a static_cast as an alternative in -such situations.

- -

Decision trees based on type are a strong indication -that your code is on the wrong track.

- -
if (typeid(*data) == typeid(D1)) {
-  ...
-} else if (typeid(*data) == typeid(D2)) {
-  ...
-} else if (typeid(*data) == typeid(D3)) {
-...
-
- -

Code such as this usually breaks when additional -subclasses are added to the class hierarchy. Moreover, -when properties of a subclass change, it is difficult to -find and modify all the affected code segments.

- -

Do not hand-implement an RTTI-like workaround. The -arguments against RTTI apply just as much to workarounds -like class hierarchies with type tags. Moreover, -workarounds disguise your true intent.

-
- -
- -

Casting

- -
-

Use C++ casts like static_cast<>(). Do -not use other cast formats like int y = -(int)x; or int y = int(x);.

-
- -
- -
-

C++ introduced a -different cast system from C that distinguishes the types -of cast operations.

-
- -
-

The problem with C casts is the ambiguity of the -operation; sometimes you are doing a conversion -(e.g., (int)3.5) and sometimes you are doing -a cast (e.g., (int)"hello"); C++ -casts avoid this. Additionally C++ casts are more visible -when searching for them.

-
- -
-

The syntax is nasty.

-
- -
-

Do not use C-style casts. Instead, use these C++-style -casts.

- -
    - - -
  • Use static_cast as the equivalent of a - C-style cast that does value conversion, or when you need to explicitly up-cast a - pointer from a class to its superclass.
    • - -
  • Use const_cast to remove the - const qualifier (see const).
    • - - - - - -
  • Use reinterpret_cast to do unsafe - conversions of pointer types to and from integer and - other pointer types. Use this only if you know what you - are doing and you understand the aliasing issues. -
    • -
- -

See the -RTTI section for guidance on the use of -dynamic_cast.

-
- -
- -

Streams

- -
-

Use streams where appropriate, and stick to "simple" -usages.

-
- -
- -
-

Streams are the standard I/O abstraction in C++, as -exemplified by the standard header <iostream>. -They are widely used in Google code, but only for debug logging -and test diagnostics.

-
- -
-

The << and >> -stream operators provide an API for formatted I/O that -is easily learned, portable, reusable, and extensible. -printf, by contrast, doesn't even support -string, to say nothing of user-defined types, -and is very difficult to use portably. -printf also obliges you to choose among the -numerous slightly different versions of that function, -and navigate the dozens of conversion specifiers.

- -

Streams provide first-class support for console I/O -via std::cin, std::cout, -std::cerr, and std::clog. -The C APIs do as well, but are hampered by the need to -manually buffer the input.

-
- -
-
    -
  • Stream formatting can be configured by mutating the -state of the stream. Such mutations are persistent, so -the behavior of your code can be affected by the entire -previous history of the stream, unless you go out of your -way to restore it to a known state every time other code -might have touched it. User code can not only modify the -built-in state, it can add new state variables and behaviors -through a registration system.
    • - -
  • It is difficult to precisely control stream output, due -to the above issues, the way code and data are mixed in -streaming code, and the use of operator overloading (which -may select a different overload than you expect).
    • - -
  • The practice of building up output through chains -of << operators interferes with -internationalization, because it bakes word order into the -code, and streams' support for localization is -flawed.
    • - - - - - -
  • The streams API is subtle and complex, so programmers must -develop experience with it in order to use it effectively. -However, streams were historically banned in Google code (except -for logging and diagnostics), so Google engineers tend not to -have that experience. Consequently, streams-based code is likely -to be less readable and maintainable by Googlers than code based -on more familiar abstractions.
    • - -
  • Resolving the many overloads of << is -extremely costly for the compiler. When used pervasively in a -large code base, it can consume as much as 20% of the parsing -and semantic analysis time.
    • -
-
- -
-

Use streams only when they are the best tool for the job. -This is typically the case when the I/O is ad-hoc, local, -human-readable, and targeted at other developers rather than -end-users. Be consistent with the code around you, and with the -codebase as a whole; if there's an established tool for -your problem, use that tool instead.

- -

Avoid using streams for I/O that faces external users or -handles untrusted data. Instead, find and use the appropriate -templating libraries to handle issues like internationalization, -localization, and security hardening.

- -

If you do use streams, avoid the stateful parts of the -streams API (other than error state), such as imbue(), -xalloc(), and register_callback(). -Use explicit formatting functions rather than -stream manipulators or formatting flags to control formatting -details such as number base, precision, or padding.

- -

Overload << as a streaming operator -for your type only if your type represents a value, and -<< writes out a human-readable string -representation of that value. Avoid exposing implementation -details in the output of <<; if you need to print -object internals for debugging, use named functions instead -(a method named DebugString() is the most common -convention).

-
- -
- -

Preincrement and Predecrement

- -
-

Use prefix form (++i) of the increment and -decrement operators with iterators and other template -objects.

-
- -
- -
-

When a variable -is incremented (++i or i++) or -decremented (--i or i--) and -the value of the expression is not used, one must decide -whether to preincrement (decrement) or postincrement -(decrement).

-
- -
-

When the return value is ignored, the "pre" form -(++i) is never less efficient than the -"post" form (i++), and is often more -efficient. This is because post-increment (or decrement) -requires a copy of i to be made, which is -the value of the expression. If i is an -iterator or other non-scalar type, copying i -could be expensive. Since the two types of increment -behave the same when the value is ignored, why not just -always pre-increment?

-
- -
-

The tradition developed, in C, of using post-increment -when the expression value is not used, especially in -for loops. Some find post-increment easier -to read, since the "subject" (i) precedes -the "verb" (++), just like in English.

-
- -
-

For simple scalar -(non-object) values there is no reason to prefer one form -and we allow either. For iterators and other template -types, use pre-increment.

-
- -
- -

Use of const

- -
-

Use const whenever it makes sense. With C++11, -constexpr is a better choice for some uses of -const.

-
- -
- -
-

Declared variables and parameters can be preceded -by the keyword const to indicate the variables -are not changed (e.g., const int foo). Class -functions can have the const qualifier to -indicate the function does not change the state of the -class member variables (e.g., class Foo { int -Bar(char c) const; };).

-
- -
-

Easier for people to understand how variables are being -used. Allows the compiler to do better type checking, -and, conceivably, generate better code. Helps people -convince themselves of program correctness because they -know the functions they call are limited in how they can -modify your variables. Helps people know what functions -are safe to use without locks in multi-threaded -programs.

-
- -
-

const is viral: if you pass a -const variable to a function, that function -must have const in its prototype (or the -variable will need a const_cast). This can -be a particular problem when calling library -functions.

-
- -
-

const variables, data members, methods -and arguments add a level of compile-time type checking; -it is better to detect errors as soon as possible. -Therefore we strongly recommend that you use -const whenever it makes sense to do so:

- -
    -
  • If a function does not modify an argument passed by - reference or by pointer, that argument should be - const.
    • - -
  • Declare methods to be const whenever - possible. Accessors should almost always be - const. Other methods should be const if - they do not modify any data members, do not call any - non-const methods, and do not return a - non-const pointer or - non-const reference to a data member.
    • - -
  • Consider making data members const - whenever they do not need to be modified after - construction.
    • -
- -

The mutable keyword is allowed but is -unsafe when used with threads, so thread safety should be -carefully considered first.

-
- -
-

Where to put the const

- -

Some people favor the form int const *foo -to const int* foo. They argue that this is -more readable because it's more consistent: it keeps the -rule that const always follows the object -it's describing. However, this consistency argument -doesn't apply in codebases with few deeply-nested pointer -expressions since most const expressions -have only one const, and it applies to the -underlying value. In such cases, there's no consistency -to maintain. Putting the const first is -arguably more readable, since it follows English in -putting the "adjective" (const) before the -"noun" (int).

- -

That said, while we encourage putting -const first, we do not require it. But be -consistent with the code around you!

-
- -
- -

Use of constexpr

- -
-

In C++11, use constexpr to define true -constants or to ensure constant initialization.

-
- -
- -
-

Some variables can be declared constexpr -to indicate the variables are true constants, i.e. fixed at -compilation/link time. Some functions and constructors -can be declared constexpr which enables them -to be used in defining a constexpr -variable.

-
- -
-

Use of constexpr enables definition of -constants with floating-point expressions rather than -just literals; definition of constants of user-defined -types; and definition of constants with function -calls.

-
- -
-

Prematurely marking something as constexpr may cause -migration problems if later on it has to be downgraded. -Current restrictions on what is allowed in constexpr -functions and constructors may invite obscure workarounds -in these definitions.

-
- -
-

constexpr definitions enable a more -robust specification of the constant parts of an -interface. Use constexpr to specify true -constants and the functions that support their -definitions. Avoid complexifying function definitions to -enable their use with constexpr. Do not use -constexpr to force inlining.

-
- -
- -

Integer Types

- -
-

Of the built-in C++ integer types, the only one used - is -int. If a program needs a variable of a -different size, use -a precise-width integer type from -<stdint.h>, such as -int16_t. If your variable represents a -value that could ever be greater than or equal to 2^31 -(2GiB), use a 64-bit type such as -int64_t. -Keep in mind that even if your value won't ever be too large -for an int, it may be used in intermediate -calculations which may require a larger type. When in doubt, -choose a larger type.

-
- -
- -
-

C++ does not specify the sizes of its integer types. -Typically people assume that short is 16 bits, -int is 32 bits, long is 32 bits -and long long is 64 bits.

-
- -
-

Uniformity of declaration.

-
- -
-

The sizes of integral types in C++ can vary based on -compiler and architecture.

-
- -
- -

-<stdint.h> defines types -like int16_t, uint32_t, -int64_t, etc. You should always use -those in preference to short, unsigned -long long and the like, when you need a guarantee -on the size of an integer. Of the C integer types, only -int should be used. When appropriate, you -are welcome to use standard types like -size_t and ptrdiff_t.

- -

We use int very often, for integers we -know are not going to be too big, e.g., loop counters. -Use plain old int for such things. You -should assume that an int is - -at least 32 bits, but don't -assume that it has more than 32 bits. If you need a 64-bit -integer type, use -int64_t -or -uint64_t.

- -

For integers we know can be "big", - use -int64_t. -

- -

You should not use the unsigned integer types such as -uint32_t, unless there is a valid -reason such as representing a bit pattern rather than a -number, or you need defined overflow modulo 2^N. In -particular, do not use unsigned types to say a number -will never be negative. Instead, use -assertions for this.

- - - -

If your code is a container that returns a size, be -sure to use a type that will accommodate any possible -usage of your container. When in doubt, use a larger type -rather than a smaller type.

- -

Use care when converting integer types. Integer -conversions and promotions can cause non-intuitive -behavior.

-
- -
- -

On Unsigned Integers

- -

Some people, including some textbook authors, -recommend using unsigned types to represent numbers that -are never negative. This is intended as a form of -self-documentation. However, in C, the advantages of such -documentation are outweighed by the real bugs it can -introduce. Consider:

- -
for (unsigned int i = foo.Length()-1; i >= 0; --i) ...
-
- -

This code will never terminate! Sometimes gcc will -notice this bug and warn you, but often it will not. -Equally bad bugs can occur when comparing signed and -unsigned variables. Basically, C's type-promotion scheme -causes unsigned types to behave differently than one -might expect.

- -

So, document that a variable is non-negative using -assertions. Don't use an unsigned -type.

-
- -
- -

64-bit Portability

- -
-

Code should be 64-bit and 32-bit friendly. Bear in mind -problems of printing, comparisons, and structure alignment.

-
- -
- -
    -
  • -

    printf() specifiers for some types - are not cleanly portable between 32-bit and 64-bit - systems. C99 defines some portable format specifiers. - Unfortunately, MSVC 7.1 does not understand some of - these specifiers and the standard is missing a few, - so we - have to define our own ugly versions in some cases - (in the style of the standard include file - inttypes.h):

    - -
    - 
    // printf macros for size_t, in the style of inttypes.h
-#ifdef _LP64
-#define __PRIS_PREFIX "z"
-#else
-#define __PRIS_PREFIX
-#endif
-
-// Use these macros after a % in a printf format string
-// to get correct 32/64 bit behavior, like this:
-// size_t size = records.size();
-// printf("%" PRIuS "\n", size);
-
-#define PRIdS __PRIS_PREFIX "d"
-#define PRIxS __PRIS_PREFIX "x"
-#define PRIuS __PRIS_PREFIX "u"
-#define PRIXS __PRIS_PREFIX "X"
-#define PRIoS __PRIS_PREFIX "o"
-
    -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    TypeDO NOT useDO useNotes
    void * (or any pointer)%lx%p
    int64_t%qd, %lld%" PRId64 "
    uint64_t%qu, %llu, - %llx%" PRIu64 ", - %" PRIx64 "
    size_t%u%" PRIuS ", %" PRIxS " - C99 specifies %zu
    ptrdiff_t%d%" PRIdS " - C99 specifies %td
    - -

    Note that the PRI* macros expand to - independent strings which are concatenated by the - compiler. Hence if you are using a non-constant - format string, you need to insert the value of the - macro into the format, rather than the name. Note also - that spaces are required around the macro identifier to - separate it from the string literal. It is - still possible, as usual, to include length - specifiers, etc., after the % when using - the PRI* macros. So, e.g. - printf("x = %30" PRIuS "\n", x) would - expand on 32-bit Linux to printf("x = %30" "u" - "\n", x), which the compiler will treat as - printf("x = %30u\n", x).

    - - -
    • - -
  • Remember that sizeof(void *) != - sizeof(int). Use intptr_t if - you want a pointer-sized integer.
    • - -
  • You may need to be careful with structure - alignments, particularly for structures being stored on - disk. Any class/structure with a - int64_t/uint64_t - member will by default end up being 8-byte aligned on a - 64-bit system. If you have such structures being shared - on disk between 32-bit and 64-bit code, you will need - to ensure that they are packed the same on both - architectures. - Most compilers offer a way to - alter structure alignment. For gcc, you can use - __attribute__((packed)). MSVC offers - #pragma pack() and - __declspec(align()).
    • - -
  • -

    Use the LL or ULL - suffixes as needed to create 64-bit constants. For - example:

    - - -
    int64_t my_value = 0x123456789LL;
-uint64_t my_mask = 3ULL << 48;
-
    -
    • -
- -
- -

Preprocessor Macros

- -
-

Be very cautious with macros. Prefer inline functions, -enums, and const variables to macros.

-
- -
- -

Macros mean that the code you see is not the same as -the code the compiler sees. This can introduce unexpected -behavior, especially since macros have global scope.

- -

Luckily, macros are not nearly as necessary in C++ as -they are in C. Instead of using a macro to inline -performance-critical code, use an inline function. -Instead of using a macro to store a constant, use a -const variable. Instead of using a macro to -"abbreviate" a long variable name, use a reference. -Instead of using a macro to conditionally compile code -... well, don't do that at all (except, of course, for -the #define guards to prevent double -inclusion of header files). It makes testing much more -difficult.

- -

Macros can do things these other techniques cannot, -and you do see them in the codebase, especially in the -lower-level libraries. And some of their special features -(like stringifying, concatenation, and so forth) are not -available through the language proper. But before using a -macro, consider carefully whether there's a non-macro way -to achieve the same result.

- -

The following usage pattern will avoid many problems -with macros; if you use macros, follow it whenever -possible:

- -
    -
  • Don't define macros in a .h file.
    • - -
  • #define macros right before you use - them, and #undef them right after.
    • - -
  • Do not just #undef an existing macro - before replacing it with your own; instead, pick a name - that's likely to be unique.
    • - -
  • Try not to use macros that expand to unbalanced C++ - constructs, or at least document that behavior - well.
    • - -
  • Prefer not using ## to generate - function/class/variable names.
    • -
- -
- -

0 and nullptr/NULL

- -
-

Use 0 for integers, 0.0 for -reals, nullptr (or NULL) for -pointers, and '\0' for chars.

-
- -
- -

Use 0 for integers and 0.0 -for reals. This is not controversial.

- -

For -pointers (address values), there is a choice between -0, NULL, and -nullptr. For projects that allow C++11 -features, use nullptr. For C++03 projects, -we prefer NULL because it looks like a -pointer. In fact, some C++ compilers provide special -definitions of NULL which enable them to -give useful warnings, particularly in situations where -sizeof(NULL) is not equal to -sizeof(0).

- -

Use '\0' for chars. This is the correct -type and also makes code more readable.

- -
- -

sizeof

- -
-

Prefer sizeof(varname) to -sizeof(type).

-
- -
- -

Use sizeof(varname) when you -take the size of a particular variable. -sizeof(varname) will update -appropriately if someone changes the variable type either -now or later. You may use -sizeof(type) for code unrelated -to any particular variable, such as code that manages an -external or internal data format where a variable of an -appropriate C++ type is not convenient.

- -
Struct data;
-memset(&data, 0, sizeof(data));
-
- -
memset(&data, 0, sizeof(Struct));
-
- -
if (raw_size < sizeof(int)) {
-  LOG(ERROR) << "compressed record not big enough for count: " << raw_size;
-  return false;
-}
-
- -
- -

auto

- -
-

Use auto to avoid type names that are just -clutter. Continue to use manifest type declarations when it -helps readability, and never use auto for -anything but local variables.

-
- -
- -
-

In C++11, a variable whose type is given as auto -will be given a type that matches that of the expression used to -initialize it. You can use auto either to -initialize a variable by copying, or to bind a -reference.

- -
vector<string> v;
-...
-auto s1 = v[0];  // Makes a copy of v[0].
-const auto& s2 = v[0];  // s2 is a reference to v[0].
-
-
- -

The auto keyword is also used in an -unrelated C++11 feature: it's part of the syntax for a -new kind of function declaration with a -trailing return type.

- - -
-

C++ type names can sometimes be long and cumbersome, -especially when they involve templates or namespaces. In -a statement like:

- -
sparse_hash_map<string, int>::iterator iter = m.find(val);
-
-
- -

the return type is hard to read, and obscures the -primary purpose of the statement. Changing it to:

- -
auto iter = m.find(val);
-
- -

makes it more readable.

- -

Without auto we are sometimes forced to -write a type name twice in the same expression, adding no -value for the reader, as in:

- -
diagnostics::ErrorStatus* status = new diagnostics::ErrorStatus("xyz");
-
- -

Using auto makes it easier to use -intermediate variables when appropriate, by reducing the -burden of writing their types explicitly.

- -
- -

Sometimes code is clearer when types are manifest, -especially when a variable's initialization depends on -things that were declared far away. In an expression -like:

- - -
auto i = x.Lookup(key);
-
- -

it may not be obvious what i's type is, -if x was declared hundreds of lines earlier.

- -

Programmers have to understand the difference between -auto and const auto& or -they'll get copies when they didn't mean to.

- -

The interaction between auto and C++11 -brace-initialization can be confusing. The exact -rules have been in flux, and compilers don't all -implement the final rules yet. -The declarations:

- -
auto x{3};
-auto y = {3};
-
- -

mean different things — -x is an int, while -y is a std::initializer_list<int>. -The same applies to other normally-invisible proxy types. -

- -

If an auto variable is used as part of an -interface, e.g. as a constant in a header, then a -programmer might change its type while only intending to -change its value, leading to a more radical API change -than intended.

-
- -
- -

auto is permitted, for local variables -only. Do not use auto for file-scope or -namespace-scope variables, or for class members. Never -initialize an auto-typed variable with -a braced initializer list. -

- -
- -

Braced Initializer List

- -
-

You may use braced initializer lists.

-
- -
- -

In C++03, aggregate types (arrays and structs with no -constructor) could be initialized with braced initializer lists. -

- -
struct Point { int x; int y; };
-Point p = {1, 2};
-
- -

In C++11, this syntax was generalized, and any object type can now -be created with a braced initializer list, known as a -braced-init-list in the C++ grammar. Here are a few examples -of its use.

- -
// Vector takes a braced-init-list of elements.
-vector<string> v{"foo", "bar"};
-
-// Basically the same, ignoring some small technicalities.
-// You may choose to use either form.
-vector<string> v = {"foo", "bar"};
-
-// Usable with 'new' expressions.
-auto p = new vector<string>{"foo", "bar"};
-
-// A map can take a list of pairs. Nested braced-init-lists work.
-map<int, string> m = {{1, "one"}, {2, "2"}};
-
-// A braced-init-list can be implicitly converted to a return type.
-vector<int> test_function() { return {1, 2, 3}; }
-
-// Iterate over a braced-init-list.
-for (int i : {-1, -2, -3}) {}
-
-// Call a function using a braced-init-list.
-void TestFunction2(vector<int> v) {}
-TestFunction2({1, 2, 3});
-
- -

A user-defined type can also define a constructor and/or assignment operator -that take std::initializer_list<T>, which is automatically -created from braced-init-list:

- -
class MyType {
- public:
-  // std::initializer_list references the underlying init list.
-  // It should be passed by value.
-  MyType(std::initializer_list<int> init_list) {
-    for (int i : init_list) append(i);
-  }
-  MyType& operator=(std::initializer_list<int> init_list) {
-    clear();
-    for (int i : init_list) append(i);
-  }
-};
-MyType m{2, 3, 5, 7};
-
- -

Finally, brace initialization can also call ordinary -constructors of data types, even if they do not have -std::initializer_list<T> constructors.

- -
double d{1.23};
-// Calls ordinary constructor as long as MyOtherType has no
-// std::initializer_list constructor.
-class MyOtherType {
- public:
-  explicit MyOtherType(string);
-  MyOtherType(int, string);
-};
-MyOtherType m = {1, "b"};
-// If the constructor is explicit, you can't use the "= {}" form.
-MyOtherType m{"b"};
-
- -

Never assign a braced-init-list to an auto -local variable. In the single element case, what this -means can be confusing.

- -
auto d = {1.23};        // d is a std::initializer_list<double>
-
- -
auto d = double{1.23};  // Good -- d is a double, not a std::initializer_list.
-
- -

See Braced_Initializer_List_Format for formatting.

- -
- -

Lambda expressions

- -
-

Use lambda expressions where appropriate. Avoid -default lambda captures when capturing this or -if the lambda will escape the current scope.

-
- -
- -
- -

Lambda expressions are a concise way of creating anonymous -function objects. They're often useful when passing -functions as arguments. For example:

- -
std::sort(v.begin(), v.end(), [](int x, int y) {
-  return Weight(x) < Weight(y);
-});
-
- -They further allow capturing variables from the enclosing scope either -explicitly by name, or implicitly using a default capture. Default captures -implicitly capture any variable referenced in the lambda body, including -this if any members are used. The default capture must come -first and be one of & for capture by reference or -= for capture by value, followed by any explicit captures which -differ from the default: - -
int weight = 3;
-int sum = 0;
-// Captures `weight` (implicitly) by value and `sum` by reference.
-std::for_each(v.begin(), v.end(), [=, &sum](int x) {
-  sum += weight * x;
-});
-
- -

Lambdas were introduced in C++11 along with a set of utilities -for working with function objects, such as the polymorphic -wrapper std::function. -

-
- -
-
    -
  • Lambdas are much more concise than other ways of - defining function objects to be passed to STL - algorithms, which can be a readability - improvement.
    • - -
  • Appropriate use of default captures can remove - redundancy and highlight important exceptions from - the default.
    • - -
  • Lambdas, std::function, and - std::bind can be used in combination as a - general purpose callback mechanism; they make it easy - to write functions that take bound functions as - arguments.
    • -
-
- -
-
    -
  • Default captures make it easy to overlook an - implicit capture and use of this. -
    • - -
  • Variable capture in lambdas can be tricky, and - might be a new source of dangling-pointer bugs, - particularly if a lambda escapes the current scope.
    • - -
  • It's possible for use of lambdas to get out of - hand; very long nested anonymous functions can make - code harder to understand.
    • - - -
-
- -
-
    -
  • Use lambda expressions where appropriate, with formatting as -described below.
    • -
  • Use default captures judiciously, when it aids readability. -In particular, prefer to write lambda captures explicitly when -capturing this or if the lambda will escape the -current scope. For example, instead of: -
    {
-  Foo foo;
-  ...
-  executor->Schedule([&] { Frobnicate(foo); })
-  ...
-}
-// BAD! `Frobnicate` may be a member function and `foo` may be destroyed
-// by the time the lambda runs.
-
    -prefer to write: -
    {
-  Foo foo;
-  ...
-  executor->Schedule([&foo] { Frobnicate(foo); })
-  ...
-}
-// GOOD - The lambda cannot accidentally capture `this` and
-// the explicit by-reference capture is more obvious and therefore
-// more likely to be checked for correctness.
-
    -
    • -
  • Keep unnamed lambdas short. If a lambda body is more than -maybe five lines long, prefer to give the lambda a name, or to -use a named function instead of a lambda.
    • -
  • Specify the return type of the lambda explicitly if that will -make it more obvious to readers, as with -auto.
    • -
-
- -
- -

Template metaprogramming

-
-

Avoid complicated template programming.

-
- -
- -
-

Template metaprogramming refers to a family of techniques that -exploit the fact that the C++ template instantiation mechanism is -Turing complete and can be used to perform arbitrary compile-time -computation in the type domain.

-
- -
-

Template metaprogramming allows extremely flexible interfaces that -are type safe and high performance. Facilities like - -Google Test, -std::tuple, std::function, and -Boost.Spirit would be impossible without it.

-
- -
-

The techniques used in template metaprogramming are often obscure -to anyone but language experts. Code that uses templates in -complicated ways is often unreadable, and is hard to debug or -maintain.

- -

Template metaprogramming often leads to extremely poor compiler -time error messages: even if an interface is simple, the complicated -implementation details become visible when the user does something -wrong.

- -

Template metaprogramming interferes with large scale refactoring by -making the job of refactoring tools harder. First, the template code -is expanded in multiple contexts, and it's hard to verify that the -transformation makes sense in all of them. Second, some refactoring -tools work with an AST that only represents the structure of the code -after template expansion. It can be difficult to automatically work -back to the original source construct that needs to be -rewritten.

-
- -
-

Template metaprogramming sometimes allows cleaner and easier-to-use -interfaces than would be possible without it, but it's also often a -temptation to be overly clever. It's best used in a small number of -low level components where the extra maintenance burden is spread out -over a large number of uses.

- -

Think twice before using template metaprogramming or other -complicated template techniques; think about whether the average -member of your team will be able to understand your code well enough -to maintain it after you switch to another project, or whether a -non-C++ programmer or someone casually browsing the code base will be -able to understand the error messages or trace the flow of a function -they want to call. If you're using recursive template instantiations -or type lists or metafunctions or expression templates, or relying on -SFINAE or on the sizeof trick for detecting function -overload resolution, then there's a good chance you've gone too -far.

- -

If you use template metaprogramming, you should expect to put -considerable effort into minimizing and isolating the complexity. You -should hide metaprogramming as an implementation detail whenever -possible, so that user-facing headers are readable, and you should -make sure that tricky code is especially well commented. You should -carefully document how the code is used, and you should say something -about what the "generated" code looks like. Pay extra attention to the -error messages that the compiler emits when users make mistakes. The -error messages are part of your user interface, and your code should -be tweaked as necessary so that the error messages are understandable -and actionable from a user point of view.

- -
-
- - -

Boost

- -
-

Use only approved libraries from the Boost library -collection.

-
- -
- -
-

The - -Boost library collection is a popular collection of -peer-reviewed, free, open-source C++ libraries.

-
- -
-

Boost code is generally very high-quality, is widely -portable, and fills many important gaps in the C++ -standard library, such as type traits and better binders.

-
- -
-

Some Boost libraries encourage coding practices which can -hamper readability, such as metaprogramming and other -advanced template techniques, and an excessively -"functional" style of programming.

-
- -
- - - -
-

In order to maintain a high level of readability for -all contributors who might read and maintain code, we -only allow an approved subset of Boost features. -Currently, the following libraries are permitted:

- -
    -
  • - - Call Traits from boost/call_traits.hpp
    • - -
  • - Compressed Pair from boost/compressed_pair.hpp
    • - -
  • - The Boost Graph Library (BGL) from boost/graph, - except serialization (adj_list_serialize.hpp) and - parallel/distributed algorithms and data structures - (boost/graph/parallel/* and - boost/graph/distributed/*).
    • - -
  • - Property Map from boost/property_map, except - parallel/distributed property maps (boost/property_map/parallel/*).
    • - -
  • - Iterator from boost/iterator
    • - -
  • The part of - Polygon that deals with Voronoi diagram - construction and doesn't depend on the rest of - Polygon: - boost/polygon/voronoi_builder.hpp, - boost/polygon/voronoi_diagram.hpp, and - boost/polygon/voronoi_geometry_type.hpp
    • - -
  • - Bimap from boost/bimap
    • - -
  • - Statistical Distributions and Functions from - boost/math/distributions
    • - -
  • - Multi-index from boost/multi_index
    • - -
  • - Heap from boost/heap
    • - -
  • The flat containers from - Container: - boost/container/flat_map, and - boost/container/flat_set
    • - -
  • - Intrusive from boost/intrusive.
    • -
- -

We are actively considering adding other Boost -features to the list, so this list may be expanded in -the future.

-
- -

The following libraries are permitted, but their use -is discouraged because they've been superseded by -standard libraries in C++11:

- - -
- -
- - - -

std::hash

- -
-

Do not define specializations of std::hash.

-
- -
- -
-

std::hash<T> is the function object that the -C++11 hash containers use to hash keys of type T, -unless the user explicitly specifies a different hash function. For -example, std::unordered_map<int, string> is a hash -map that uses std::hash<int> to hash its keys, -whereas std::unordered_map<int, string, MyIntHash> -uses MyIntHash.

- -

std::hash is defined for all integral, floating-point, -pointer, and enum types, as well as some standard library -types such as string and unique_ptr. Users -can enable it to work for their own types by defining specializations -of it for those types.

-
- -
-

std::hash is easy to use, and simplifies the code -since you don't have to name it explicitly. Specializing -std::hash is the standard way of specifying how to -hash a type, so it's what outside resources will teach, and what -new engineers will expect.

-
- -
-

std::hash is hard to specialize. It requires a lot -of boilerplate code, and more importantly, it combines responsibility -for identifying the hash inputs with responsibility for executing the -hashing algorithm itself. The type author has to be responsible for -the former, but the latter requires expertise that a type author -usually doesn't have, and shouldn't need. The stakes here are high -because low-quality hash functions can be security vulnerabilities, -due to the emergence of - -hash flooding attacks.

- -

Even for experts, std::hash specializations are -inordinately difficult to implement correctly for compound types, -because the implementation cannot recursively call std::hash -on data members. High-quality hash algorithms maintain large -amounts of internal state, and reducing that state to the -size_t bytes that std::hash -returns is usually the slowest part of the computation, so it -should not be done more than once.

- -

Due to exactly that issue, std::hash does not work -with std::pair or std::tuple, and the -language does not allow us to extend it to support them.

-
- -
-

You can use std::hash with the types that it supports -"out of the box", but do not specialize it to support additional types. -If you need a hash table with a key type that std::hash -does not support, consider using legacy hash containers (e.g. -hash_map) for now; they use a different default hasher, -which is unaffected by this prohibition.

- -

If you want to use the standard hash containers anyway, you will -need to specify a custom hasher for the key type, e.g.

-
std::unordered_map<MyKeyType, Value, MyKeyTypeHasher> my_map;
-

-Consult with the type's owners to see if there is an existing hasher -that you can use; otherwise work with them to provide one, - or roll your own.

- -

We are planning to provide a hash function that can work with any type, -using a new customization mechanism that doesn't have the drawbacks of -std::hash.

-
- -
- -

C++11

- -
-

Use libraries and language extensions from C++11 when appropriate. -Consider portability to other environments -before using C++11 features in your -project.

- -
- -
- -
-

C++11 contains -significant changes both to the language and -libraries.

-
- -
-

C++11 was the official standard until august 2014, and -is supported by most C++ compilers. It standardizes -some common C++ extensions that we use already, allows -shorthands for some operations, and has some performance -and safety improvements.

-
- -
-

The C++11 standard is substantially more complex than -its predecessor (1,300 pages versus 800 pages), and is -unfamiliar to many developers. The long-term effects of -some features on code readability and maintenance are -unknown. We cannot predict when its various features will -be implemented uniformly by tools that may be of -interest, particularly in the case of projects that are -forced to use older versions of tools.

- -

As with Boost, some C++11 -extensions encourage coding practices that hamper -readability—for example by removing -checked redundancy (such as type names) that may be -helpful to readers, or by encouraging template -metaprogramming. Other extensions duplicate functionality -available through existing mechanisms, which may lead to confusion -and conversion costs.

- - -
- -
- -

C++11 features may be used unless specified otherwise. -In addition to what's described in the rest of the style -guide, the following C++11 features may not be used:

- -
    - - - - - - - - -
  • Compile-time rational numbers - (<ratio>), because of concerns that - it's tied to a more template-heavy interface - style.
    • - -
  • The <cfenv> and - <fenv.h> headers, because many - compilers do not support those features reliably.
    • - -
-
- -
- -

Naming

- -

The most important consistency rules are those that govern -naming. The style of a name immediately informs us what sort of -thing the named entity is: a type, a variable, a function, a -constant, a macro, etc., without requiring us to search for the -declaration of that entity. The pattern-matching engine in our -brains relies a great deal on these naming rules. -

- -

Naming rules are pretty arbitrary, but - we feel that -consistency is more important than individual preferences in this -area, so regardless of whether you find them sensible or not, -the rules are the rules.

- -

General Naming Rules

- -
-

Names should be descriptive; eschew abbreviation.

-
- -
-

Give as descriptive a name as possible, within reason. -Do not worry about saving horizontal space as it is far -more important to make your code immediately -understandable by a new reader. Do not use abbreviations -that are ambiguous or unfamiliar to readers outside your -project, and do not abbreviate by deleting letters within -a word.

- -
int price_count_reader;    // No abbreviation.
-int num_errors;            // "num" is a widespread convention.
-int num_dns_connections;   // Most people know what "DNS" stands for.
-
- -
int n;                     // Meaningless.
-int nerr;                  // Ambiguous abbreviation.
-int n_comp_conns;          // Ambiguous abbreviation.
-int wgc_connections;       // Only your group knows what this stands for.
-int pc_reader;             // Lots of things can be abbreviated "pc".
-int cstmr_id;              // Deletes internal letters.
-
- -
- -

File Names

- -
-

Filenames should be all lowercase and can include -underscores (_) or dashes (-). -Follow the convention that your - -project uses. If there is no consistent -local pattern to follow, prefer "_".

-
- -
- -

Examples of acceptable file names:

- -
    -
  • my_useful_class.cc
    • -
  • my-useful-class.cc
    • -
  • myusefulclass.cc
    • -
  • myusefulclass_test.cc // _unittest and _regtest are deprecated.
    • -
- -

C++ files should end in .cc and header files should end in -.h. Files that rely on being textually included at specific points -should end in .inc (see also the section on -self-contained headers).

- -

Do not use filenames that already exist in -/usr/include, such as db.h.

- -

In general, make your filenames very specific. For -example, use http_server_logs.h rather than -logs.h. A very common case is to have a pair -of files called, e.g., foo_bar.h and -foo_bar.cc, defining a class called -FooBar.

- -

Inline functions must be in a .h file. If -your inline functions are very short, they should go -directly into your .h file.

- -
- -

Type Names

- -
-

Type names start with a capital letter and have a capital -letter for each new word, with no underscores: -MyExcitingClass, MyExcitingEnum.

-
- -
- -

The names of all types — classes, structs, typedefs, -enums, and type template parameters — have the same naming convention. -Type names should start with a capital letter and have a capital letter -for each new word. No underscores. For example:

- -
// classes and structs
-class UrlTable { ...
-class UrlTableTester { ...
-struct UrlTableProperties { ...
-
-// typedefs
-typedef hash_map<UrlTableProperties *, string> PropertiesMap;
-
-// enums
-enum UrlTableErrors { ...
-
- -
- -

Variable Names

- -
-

The names of variables and data members are all lowercase, with -underscores between words. Data members of classes (but not structs) -additionally have trailing underscores. For instance: -a_local_variable, a_struct_data_member, -a_class_data_member_.

-
- -
- -

Common Variable names

- -

For example:

- -
string table_name;  // OK - uses underscore.
-string tablename;   // OK - all lowercase.
-
- -
string tableName;   // Bad - mixed case.
-
- -

Class Data Members

- -

Data members of classes, both static and non-static, are -named like ordinary nonmember variables, but with a -trailing underscore.

- -
class TableInfo {
-  ...
- private:
-  string table_name_;  // OK - underscore at end.
-  string tablename_;   // OK.
-  static Pool<TableInfo>* pool_;  // OK.
-};
-
- -

Struct Data Members

- -

Data members of structs, both static and non-static, -are named like ordinary nonmember variables. They do not have -the trailing underscores that data members in classes have.

- -
struct UrlTableProperties {
-  string name;
-  int num_entries;
-  static Pool<UrlTableProperties>* pool;
-};
-
- - -

See Structs vs. -Classes for a discussion of when to use a struct -versus a class.

- -

Global Variables

- -

There are no special requirements for global -variables, which should be rare in any case, but if you -use one, consider prefixing it with g_ or -some other marker to easily distinguish it from local -variables.

- -
- -

Constant Names

- -
-

Variables declared constexpr or const, and whose value is fixed for - the duration of the program, are named with a leading "k" followed - by mixed case. For example:

-
- -
const int kDaysInAWeek = 7;
-
- -
- -

All such variables with static storage duration (i.e. statics and globals, - see - Storage Duration for details) should be named this way. This - convention is optional for variables of other storage classes, e.g. automatic - variables, otherwise the usual variable naming rules apply.

- -

- -

Function Names

- -
-

Regular functions have mixed case; "cheap" functions may -use lower case with underscores.

-
- -
- -

Ordinarily, functions should start with a capital letter and have -a capital letter for each new word (a.k.a. "upper camel case" or "Pascal case"). -Such names should not have underscores. Prefer to capitalize acronyms as -single words (i.e. StartRpc(), not StartRPC()).

- -
AddTableEntry()
-DeleteUrl()
-OpenFileOrDie()
-
- -

Functions that are very cheap to call may instead follow the style -for variable names (all lower-case, with underscores between words). -The rule of thumb is that such a function should be so cheap that you -normally wouldn't bother caching its return value when calling it in -a loop. A canonical example is an inline method that just returns one -of the class's member variables.

- -
class MyClass {
- public:
-  ...
-  bool is_empty() const { return num_entries_ == 0; }
-
- private:
-  int num_entries_;
-};
-
-
- -

Namespace Names

- -
-Namespace names are all lower-case. Top-level -namespace names are based on the project name -. -
- -
-

The name of a top-level namespace should usually be the -name of the project or team whose code is contained in that -namespace. The code in that namespace should usually be in -a directory whose basename matches the namespace name (or -subdirectories thereof).

- - - - - -

Keep in mind that the rule -against abbreviated names applies to namespaces just as much -as variable names. Code inside the namespace seldom needs to -mention the namespace name, so there's usually no particular need -for abbreviation anyway.

- -

Naming conventions for nested namespaces are at the discretion -of the team owning the enclosing namespace. If a nested namespace -is used to group related functions in a single header file, consider basing -its name on the header name, e.g. namespace foo::bar -for functions defined in the header file bar.h. -If the nested namespace is being used to distinguish implementation -details from user-facing declarations, one common choice is -internal.

- -
- -

Enumerator Names

- -
-

Enumerators should be named either like -constants or like -macros: either kEnumName or -ENUM_NAME.

-
- -
- -

Preferably, the individual enumerators should be named -like constants. However, it -is also acceptable to name them like -macros. The enumeration name, -UrlTableErrors (and -AlternateUrlTableErrors), is a type, and -therefore mixed case.

- -
enum UrlTableErrors {
-  kOK = 0,
-  kErrorOutOfMemory,
-  kErrorMalformedInput,
-};
-enum AlternateUrlTableErrors {
-  OK = 0,
-  OUT_OF_MEMORY = 1,
-  MALFORMED_INPUT = 2,
-};
-
- -

Until January 2009, the style was to name enum values -like macros. This caused -problems with name collisions between enum values and -macros. Hence, the change to prefer constant-style naming -was put in place. New code should prefer constant-style -naming if possible. However, there is no reason to change -old code to use constant-style names, unless the old -names are actually causing a compile-time problem.

- - - -
- -

Macro Names

- -
-

You're not really going to -define a macro, are you? If you do, they're like this: -MY_MACRO_THAT_SCARES_SMALL_CHILDREN.

-
- -
- -

Please see the description -of macros; in general macros should not be used. -However, if they are absolutely needed, then they should be -named with all capitals and underscores.

- -
#define ROUND(x) ...
-#define PI_ROUNDED 3.0
-
- -
- -

Exceptions to Naming Rules

- -
-

If you are naming something that is analogous to an -existing C or C++ entity then you can follow the existing -naming convention scheme.

-
- -
- -
-
bigopen()
-
function name, follows form of open()
- -
uint
-
typedef
- -
bigpos
-
struct or class, follows - form of pos
- -
sparse_hash_map
-
STL-like entity; follows STL naming conventions
- -
LONGLONG_MAX
-
a constant, as in INT_MAX
-
- -
- -

Comments

- -

Though a pain to write, comments are absolutely vital to -keeping our code readable. The following rules describe what -you should comment and where. But remember: while comments are -very important, the best code is self-documenting. Giving -sensible names to types and variables is much better than using -obscure names that you must then explain through comments.

- -

When writing your comments, write for your audience: the -next -contributor who will need to -understand your code. Be generous — the next -one may be you!

- -

Comment Style

- -
-

Use either the // or /* */ -syntax, as long as you are consistent.

-
- -
- -

You can use either the // or the /* -*/ syntax; however, // is -much more common. Be consistent with how you -comment and what style you use where.

- -
- -

File Comments

- -
-

Start each file with license -boilerplate, followed by a description of its -contents.

-
- -
- -

Legal Notice and Author -Line

- - - -

Every file should contain license -boilerplate. Choose the appropriate boilerplate for the -license used by the project (for example, Apache 2.0, -BSD, LGPL, GPL).

- -

If you make significant changes to a file with an -author line, consider deleting the author line.

- -

File Contents

- -

Every file should have a comment at the top describing -its contents, unless the specific conditions described below apply.

- -

A file-level comment in a .h should broadly describe -the contents of the file. If the file declares multiple abstractions, the -file-level comment should document how they are related. A 1 or 2 sentence -file-level comment may be sufficient. The detailed documentation about -individual abstractions belongs with those abstractions, not at the file -level.

- -

Do not duplicate comments in both the .h and the -.cc. Duplicated comments diverge.

- -

A file-level comment may be omitted if the file declares, implements, or -tests exactly one abstraction that is documented by a comment at the point -of declaration.

- -

- -

Class Comments

- -
-

Every class definition should have an accompanying comment -that describes what it is for and how it should be used.

-
- -
- -
// Iterates over the contents of a GargantuanTable.
-// Example:
-//    GargantuanTableIterator* iter = table->NewIterator();
-//    for (iter->Seek("foo"); !iter->done(); iter->Next()) {
-//      process(iter->key(), iter->value());
-//    }
-//    delete iter;
-class GargantuanTableIterator {
-  ...
-};
-
- -

The class comment should provide the reader with enough information to know -how and when to use the class, as well as any additional considerations -necessary to correctly use the class. Document the synchronization assumptions -the class makes, if any. If an instance of the class can be accessed by -multiple threads, take extra care to document the rules and invariants -surrounding multithreaded use.

- -

The class comment is often a good place for a small example code snippet -demonstrating a simple and focused usage of the class.

- -
- -

Function Comments

- -
-

Declaration comments describe use of the function; comments -at the definition of a function describe operation.

-
- -
- -

Function Declarations

- -

Every function declaration should have comments -immediately preceding it that describe what the function -does and how to use it. These comments should be -descriptive ("Opens the file") rather than imperative -("Open the file"); the comment describes the function, it -does not tell the function what to do. In general, these -comments do not describe how the function performs its -task. Instead, that should be left to comments in the -function definition.

- -

Types of things to mention in comments at the function -declaration:

- -
    -
  • What the inputs and outputs are.
    • - -
  • For class member functions: whether the object - remembers reference arguments beyond the duration of - the method call, and whether it will free them or - not.
    • - -
  • If the function allocates memory that the caller - must free.
    • - -
  • Whether any of the arguments can be a null - pointer.
    • - -
  • If there are any performance implications of how a - function is used.
    • - -
  • If the function is re-entrant. What are its - synchronization assumptions?
    • -
- -

Here is an example:

- -
// Returns an iterator for this table.  It is the client's
-// responsibility to delete the iterator when it is done with it,
-// and it must not use the iterator once the GargantuanTable object
-// on which the iterator was created has been deleted.
-//
-// The iterator is initially positioned at the beginning of the table.
-//
-// This method is equivalent to:
-//    Iterator* iter = table->NewIterator();
-//    iter->Seek("");
-//    return iter;
-// If you are going to immediately seek to another place in the
-// returned iterator, it will be faster to use NewIterator()
-// and avoid the extra seek.
-Iterator* GetIterator() const;
-
- -

However, do not be unnecessarily verbose or state the -completely obvious. Notice below that it is not necessary - to say "returns false otherwise" because this is -implied.

- -
// Returns true if the table cannot hold any more entries.
-bool IsTableFull();
-
- -

When documenting function overrides, focus on the -specifics of the override itself, rather than repeating -the comment from the overriden function. In many of these -cases, the override needs no additional documentation and -thus no comment is required.

- -

When commenting constructors and destructors, remember -that the person reading your code knows what constructors -and destructors are for, so comments that just say -something like "destroys this object" are not useful. -Document what constructors do with their arguments (for -example, if they take ownership of pointers), and what -cleanup the destructor does. If this is trivial, just -skip the comment. It is quite common for destructors not -to have a header comment.

- -

Function Definitions

- -

If there is anything tricky about how a function does -its job, the function definition should have an -explanatory comment. For example, in the definition -comment you might describe any coding tricks you use, -give an overview of the steps you go through, or explain -why you chose to implement the function in the way you -did rather than using a viable alternative. For instance, -you might mention why it must acquire a lock for the -first half of the function but why it is not needed for -the second half.

- -

Note you should not just repeat the comments -given with the function declaration, in the -.h file or wherever. It's okay to -recapitulate briefly what the function does, but the -focus of the comments should be on how it does it.

- -
- -

Variable Comments

- -
-

In general the actual name of the variable should be -descriptive enough to give a good idea of what the variable -is used for. In certain cases, more comments are required.

-
- -
- -

Class Data Members

- -

Each class data member (also called an instance -variable or member variable) should have a comment -describing what it is used for. If the variable can take -sentinel values with special meanings, such as a null -pointer or -1, document this. For example:

- - -
private:
- // Keeps track of the total number of entries in the table.
- // Used to ensure we do not go over the limit. -1 means
- // that we don't yet know how many entries the table has.
- int num_total_entries_;
-
- -

Global Variables

- -

As with data members, all global variables should have -a comment describing what they are and what they are used -for. For example:

- -
// The total number of tests cases that we run through in this regression test.
-const int kNumTestCases = 6;
-
- -
- -

Implementation Comments

- -
-

In your implementation you should have comments in tricky, -non-obvious, interesting, or important parts of your code.

-
- -
- -

Explanatory Comments

- -

Tricky or complicated code blocks should have comments -before them. Example:

- -
// Divide result by two, taking into account that x
-// contains the carry from the add.
-for (int i = 0; i < result->size(); i++) {
-  x = (x << 8) + (*result)[i];
-  (*result)[i] = x >> 1;
-  x &= 1;
-}
-
- -

Line Comments

- -

Also, lines that are non-obvious should get a comment -at the end of the line. These end-of-line comments should -be separated from the code by 2 spaces. Example:

- -
// If we have enough memory, mmap the data portion too.
-mmap_budget = max<int64>(0, mmap_budget - index_->length());
-if (mmap_budget >= data_size_ && !MmapData(mmap_chunk_bytes, mlock))
-  return;  // Error already logged.
-
- -

Note that there are both comments that describe what -the code is doing, and comments that mention that an -error has already been logged when the function -returns.

- -

If you have several comments on subsequent lines, it -can often be more readable to line them up:

- -
DoSomething();                  // Comment here so the comments line up.
-DoSomethingElseThatIsLonger();  // Two spaces between the code and the comment.
-{ // One space before comment when opening a new scope is allowed,
-  // thus the comment lines up with the following comments and code.
-  DoSomethingElse();  // Two spaces before line comments normally.
-}
-vector<string> list{// Comments in braced lists describe the next element ..
-                    "First item",
-                    // .. and should be aligned appropriately.
-                    "Second item"};
-DoSomething(); /* For trailing block comments, one space is fine. */
-
- -

Function Argument Comments

- -

When the meaning of a function argument is nonobvious, consider -one of the following remedies:

- -
    -
  • If the argument is a literal constant, and the same constant is - used in multiple function calls in a way that tacitly assumes they're - the same, you should use a named constant to make that constraint - explicit, and to guarantee that it holds.
    • - -
  • Consider changing the function signature to replace a bool - argument with an enum argument. This will make the argument - values self-describing.
    • - -
  • For functions that have several configuration options, consider - defining a single class or struct to hold all the options - , - and pass an instance of that. - This approach has several advantages. Options are referenced by name - at the call site, which clarifies their meaning. It also reduces - function argument count, which makes function calls easier to read and - write. As an added benefit, you don't have to change call sites when - you add another option. -
    • - -
  • Replace large or complex nested expressions with named variables.
    • - -
  • As a last resort, use comments to clarify argument meanings at the - call site.
    • -
- -Consider the following example: - -
// What are these arguments?
-const DecimalNumber product = CalculateProduct(values, 7, false, nullptr);
-
- -

versus:

- -
ProductOptions options;
-options.set_precision_decimals(7);
-options.set_use_cache(ProductOptions::kDontUseCache);
-const DecimalNumber product =
-    CalculateProduct(values, options, /*completion_callback=*/nullptr);
-
- -

Don'ts

- -

Do not state the obvious. In particular, don't literally describe what -code does, unless the behavior is nonobvious to a reader who understands -C++ well. Instead, provide higher level comments that describe why -the code does what it does, or make the code self describing.

- -Compare this: - -
// Find the element in the vector.  <-- Bad: obvious!
-auto iter = std::find(v.begin(), v.end(), element);
-if (iter != v.end()) {
-  Process(element);
-}
-
- -To this: - -
// Process "element" unless it was already processed.
-auto iter = std::find(v.begin(), v.end(), element);
-if (iter != v.end()) {
-  Process(element);
-}
-
- -Self-describing code doesn't need a comment. The comment from -the example above would be obvious: - -
if (!IsAlreadyProcessed(element)) {
-  Process(element);
-}
-
- -
- -

Punctuation, Spelling and Grammar

- -
-

Pay attention to punctuation, spelling, and grammar; it is -easier to read well-written comments than badly written -ones.

-
- -
- -

Comments should be as readable as narrative text, with -proper capitalization and punctuation. In many cases, -complete sentences are more readable than sentence -fragments. Shorter comments, such as comments at the end -of a line of code, can sometimes be less formal, but you -should be consistent with your style.

- -

Although it can be frustrating to have a code reviewer -point out that you are using a comma when you should be -using a semicolon, it is very important that source code -maintain a high level of clarity and readability. Proper -punctuation, spelling, and grammar help with that -goal.

- -
- -

TODO Comments

- -
-

Use TODO comments for code that is temporary, -a short-term solution, or good-enough but not perfect.

-
- -
- -

TODOs should include the string -TODO in all caps, followed by the - -name, e-mail address, or other -identifier of the person - with the best context -about the problem referenced by the TODO. The -main purpose is to have a consistent TODO that -can be searched to find out how to get more details upon -request. A TODO is not a commitment that the -person referenced will fix the problem. Thus when you create -a TODO, it is almost always your - -name -that is given.

- - - -
-
// TODO(kl@gmail.com): Use a "*" here for concatenation operator.
-// TODO(Zeke) change this to use relations.
-
-
- -

If your TODO is of the form "At a future -date do something" make sure that you either include a -very specific date ("Fix by November 2005") or a very -specific event ("Remove this code when all clients can -handle XML responses.").

- -
- -

Deprecation Comments

- -
-

Mark deprecated interface points with DEPRECATED -comments.

-
- -
- -

You can mark an interface as deprecated by writing a -comment containing the word DEPRECATED in -all caps. The comment goes either before the declaration -of the interface or on the same line as the -declaration.

- - - -

After the word -DEPRECATED, write your name, e-mail address, -or other identifier in parentheses.

- -

A deprecation comment must include simple, clear -directions for people to fix their callsites. In C++, you -can implement a deprecated function as an inline function -that calls the new interface point.

- -

Marking an interface point DEPRECATED -will not magically cause any callsites to change. If you -want people to actually stop using the deprecated -facility, you will have to fix the callsites yourself or -recruit a crew to help you.

- -

New code should not contain calls to deprecated -interface points. Use the new interface point instead. If -you cannot understand the directions, find the person who -created the deprecation and ask them for help using the -new interface point.

- - - -
- -

Formatting

- -

Coding style and formatting are pretty arbitrary, but a - -project is much easier to follow -if everyone uses the same style. Individuals may not agree with every -aspect of the formatting rules, and some of the rules may take -some getting used to, but it is important that all - -project contributors follow the -style rules so that -they can all read and understand -everyone's code easily.

- - - -

To help you format code correctly, we've -created a - -settings file for emacs.

- -

Line Length

- -
-

Each line of text in your code should be at most 80 -characters long.

-
- -
- - - -

We recognize that this rule is -controversial, but so much existing code already adheres -to it, and we feel that consistency is important.

- -
-

Those who favor this rule -argue that it is rude to force them to resize -their windows and there is no need for anything longer. -Some folks are used to having several code windows -side-by-side, and thus don't have room to widen their -windows in any case. People set up their work environment -assuming a particular maximum window width, and 80 -columns has been the traditional standard. Why change -it?

-
- -
-

Proponents of change argue that a wider line can make -code more readable. The 80-column limit is an hidebound -throwback to 1960s mainframes; modern equipment has wide screens that -can easily show longer lines.

-
- -
-

80 characters is the maximum.

- -

Comment lines can be longer than 80 -characters if it is not feasible to split them without -harming readability, ease of cut and paste or auto-linking --- e.g. if a line contains an example command or a literal -URL longer than 80 characters.

- -

A raw-string literal may have content -that exceeds 80 characters. Except for test code, such literals -should appear near top of a file.

- -

An #include statement with a -long path may exceed 80 columns.

- -

You needn't be concerned about -header guards that exceed -the maximum length.

-
- -
- -

Non-ASCII Characters

- -
-

Non-ASCII characters should be rare, and must use UTF-8 -formatting.

-
- -
- -

You shouldn't hard-code user-facing text in source, -even English, so use of non-ASCII characters should be -rare. However, in certain cases it is appropriate to -include such words in your code. For example, if your -code parses data files from foreign sources, it may be -appropriate to hard-code the non-ASCII string(s) used in -those data files as delimiters. More commonly, unittest -code (which does not need to be localized) might -contain non-ASCII strings. In such cases, you should use -UTF-8, since that is an encoding -understood by most tools able to handle more than just -ASCII.

- -

Hex encoding is also OK, and encouraged where it -enhances readability — for example, -"\xEF\xBB\xBF", or, even more simply, -u8"\uFEFF", is the Unicode zero-width -no-break space character, which would be invisible if -included in the source as straight UTF-8.

- -

Use the u8 prefix -to guarantee that a string literal containing -\uXXXX escape sequences is encoded as UTF-8. -Do not use it for strings containing non-ASCII characters -encoded as UTF-8, because that will produce incorrect -output if the compiler does not interpret the source file -as UTF-8.

- -

You shouldn't use the C++11 char16_t and -char32_t character types, since they're for -non-UTF-8 text. For similar reasons you also shouldn't -use wchar_t (unless you're writing code that -interacts with the Windows API, which uses -wchar_t extensively).

- -
- -

Spaces vs. Tabs

- -
-

Use only spaces, and indent 2 spaces at a time.

-
- -
- -

We use spaces for indentation. Do not use tabs in your -code. You should set your editor to emit spaces when you -hit the tab key.

- -
- -

Function Declarations and Definitions

- -
-

Return type on the same line as function name, parameters -on the same line if they fit. Wrap parameter lists which do -not fit on a single line as you would wrap arguments in a -function call.

-
- -
- -

Functions look like this:

- - -
ReturnType ClassName::FunctionName(Type par_name1, Type par_name2) {
-  DoSomething();
-  ...
-}
-
- -

If you have too much text to fit on one line:

- -
ReturnType ClassName::ReallyLongFunctionName(Type par_name1, Type par_name2,
-                                             Type par_name3) {
-  DoSomething();
-  ...
-}
-
- -

or if you cannot fit even the first parameter:

- -
ReturnType LongClassName::ReallyReallyReallyLongFunctionName(
-    Type par_name1,  // 4 space indent
-    Type par_name2,
-    Type par_name3) {
-  DoSomething();  // 2 space indent
-  ...
-}
-
- -

Some points to note:

- -
    -
  • Choose good parameter names.
    • - -
  • Parameter names may be omitted only if the parameter is unused and its - purpose is obvious.
    • - -
  • If you cannot fit the return type and the function - name on a single line, break between them.
    • - -
  • If you break after the return type of a function - declaration or definition, do not indent.
    • - -
  • The open parenthesis is always on the same line as - the function name.
    • - -
  • There is never a space between the function name - and the open parenthesis.
    • - -
  • There is never a space between the parentheses and - the parameters.
    • - -
  • The open curly brace is always on the end of the last line of the function - declaration, not the start of the next line.
    • - -
  • The close curly brace is either on the last line by - itself or on the same line as the open curly brace.
    • - -
  • There should be a space between the close - parenthesis and the open curly brace.
    • - -
  • All parameters should be aligned if possible.
    • - -
  • Default indentation is 2 spaces.
    • - -
  • Wrapped parameters have a 4 space indent.
    • -
- -

Unused parameters that are obvious from context may be omitted:

- -
class Foo {
- public:
-  Foo(Foo&&) = default;
-  Foo(const Foo&) = default;
-  Foo& operator=(Foo&&) = default;
-  Foo& operator=(const Foo&) = default;
-};
-
- -

Unused parameters that might not be obvious should comment out the variable -name in the function definition:

- -
class Shape {
- public:
-  virtual void Rotate(double radians) = 0;
-};
-
-class Circle : public Shape {
- public:
-  void Rotate(double radians) override;
-};
-
-void Circle::Rotate(double /*radians*/) {}
-
- -
// Bad - if someone wants to implement later, it's not clear what the
-// variable means.
-void Circle::Rotate(double) {}
-
- -
- -

Lambda Expressions

- -
-

Format parameters and bodies as for any other function, and capture -lists like other comma-separated lists.

-
- -
-

For by-reference captures, do not leave a space between the -ampersand (&) and the variable name.

-
int x = 0;
-auto add_to_x = [&x](int n) { x += n; };
-
-

Short lambdas may be written inline as function arguments.

-
set<int> blacklist = {7, 8, 9};
-vector<int> digits = {3, 9, 1, 8, 4, 7, 1};
-digits.erase(std::remove_if(digits.begin(), digits.end(), [&blacklist](int i) {
-               return blacklist.find(i) != blacklist.end();
-             }),
-             digits.end());
-
- -
- -

Function Calls

- -
-

Either write the call all on a single line, wrap the -arguments at the parenthesis, or start the arguments on a new -line indented by four spaces and continue at that 4 space -indent. In the absence of other considerations, use the -minimum number of lines, including placing multiple arguments -on each line where appropriate.

-
- -
- -

Function calls have the following format:

-
bool result = DoSomething(argument1, argument2, argument3);
-
- -

If the arguments do not all fit on one line, they -should be broken up onto multiple lines, with each -subsequent line aligned with the first argument. Do not -add spaces after the open paren or before the close -paren:

-
bool result = DoSomething(averyveryveryverylongargument1,
-                          argument2, argument3);
-
- -

Arguments may optionally all be placed on subsequent -lines with a four space indent:

-
if (...) {
-  ...
-  ...
-  if (...) {
-    bool result = DoSomething(
-        argument1, argument2,  // 4 space indent
-        argument3, argument4);
-    ...
-  }
-
- -

Put multiple arguments on a single line to reduce the -number of lines necessary for calling a function unless -there is a specific readability problem. Some find that -formatting with strictly one argument on each line is -more readable and simplifies editing of the arguments. -However, we prioritize for the reader over the ease of -editing arguments, and most readability problems are -better addressed with the following techniques.

- -

If having multiple arguments in a single line decreases -readability due to the complexity or confusing nature of the -expressions that make up some arguments, try creating -variables that capture those arguments in a descriptive name:

-
int my_heuristic = scores[x] * y + bases[x];
-bool result = DoSomething(my_heuristic, x, y, z);
-
- -

Or put the confusing argument on its own line with -an explanatory comment:

-
bool result = DoSomething(scores[x] * y + bases[x],  // Score heuristic.
-                          x, y, z);
-
- -

If there is still a case where one argument is -significantly more readable on its own line, then put it on -its own line. The decision should be specific to the argument -which is made more readable rather than a general policy.

- -

Sometimes arguments form a structure that is important -for readability. In those cases, feel free to format the -arguments according to that structure:

-
// Transform the widget by a 3x3 matrix.
-my_widget.Transform(x1, x2, x3,
-                    y1, y2, y3,
-                    z1, z2, z3);
-
- -
- -

Braced Initializer List Format

- -
-

Format a braced initializer list -exactly like you would format a function call in its place.

-
- -
- -

If the braced list follows a name (e.g. a type or -variable name), format as if the {} were the -parentheses of a function call with that name. If there -is no name, assume a zero-length name.

- -
// Examples of braced init list on a single line.
-return {foo, bar};
-functioncall({foo, bar});
-pair<int, int> p{foo, bar};
-
-// When you have to wrap.
-SomeFunction(
-    {"assume a zero-length name before {"},
-    some_other_function_parameter);
-SomeType variable{
-    some, other, values,
-    {"assume a zero-length name before {"},
-    SomeOtherType{
-        "Very long string requiring the surrounding breaks.",
-        some, other values},
-    SomeOtherType{"Slightly shorter string",
-                  some, other, values}};
-SomeType variable{
-    "This is too long to fit all in one line"};
-MyType m = {  // Here, you could also break before {.
-    superlongvariablename1,
-    superlongvariablename2,
-    {short, interior, list},
-    {interiorwrappinglist,
-     interiorwrappinglist2}};
-
- -
- -

Conditionals

- -
-

Prefer no spaces inside parentheses. The if -and else keywords belong on separate lines.

-
- -
- -

There are two acceptable formats for a basic -conditional statement. One includes spaces between the -parentheses and the condition, and one does not.

- -

The most common form is without spaces. Either is -fine, but be consistent. If you are modifying a -file, use the format that is already present. If you are -writing new code, use the format that the other files in -that directory or project use. If in doubt and you have -no personal preference, do not add the spaces.

- -
if (condition) {  // no spaces inside parentheses
-  ...  // 2 space indent.
-} else if (...) {  // The else goes on the same line as the closing brace.
-  ...
-} else {
-  ...
-}
-
- -

If you prefer you may add spaces inside the -parentheses:

- -
if ( condition ) {  // spaces inside parentheses - rare
-  ...  // 2 space indent.
-} else {  // The else goes on the same line as the closing brace.
-  ...
-}
-
- -

Note that in all cases you must have a space between -the if and the open parenthesis. You must -also have a space between the close parenthesis and the -curly brace, if you're using one.

- -
if(condition) {   // Bad - space missing after IF.
-if (condition){   // Bad - space missing before {.
-if(condition){    // Doubly bad.
-
- -
if (condition) {  // Good - proper space after IF and before {.
-
- -

Short conditional statements may be written on one -line if this enhances readability. You may use this only -when the line is brief and the statement does not use the -else clause.

- -
if (x == kFoo) return new Foo();
-if (x == kBar) return new Bar();
-
- -

This is not allowed when the if statement has an -else:

- -
// Not allowed - IF statement on one line when there is an ELSE clause
-if (x) DoThis();
-else DoThat();
-
- -

In general, curly braces are not required for -single-line statements, but they are allowed if you like -them; conditional or loop statements with complex -conditions or statements may be more readable with curly -braces. Some -projects require that an -if must always always have an accompanying -brace.

- -
if (condition)
-  DoSomething();  // 2 space indent.
-
-if (condition) {
-  DoSomething();  // 2 space indent.
-}
-
- -

However, if one part of an -if-else statement uses curly -braces, the other part must too:

- -
// Not allowed - curly on IF but not ELSE
-if (condition) {
-  foo;
-} else
-  bar;
-
-// Not allowed - curly on ELSE but not IF
-if (condition)
-  foo;
-else {
-  bar;
-}
-
- -
// Curly braces around both IF and ELSE required because
-// one of the clauses used braces.
-if (condition) {
-  foo;
-} else {
-  bar;
-}
-
- -
- -

Loops and Switch Statements

- -
-

Switch statements may use braces for blocks. Annotate -non-trivial fall-through between cases. -Braces are optional for single-statement loops. -Empty loop bodies should use {} or continue.

-
- -
- -

case blocks in switch -statements can have curly braces or not, depending on -your preference. If you do include curly braces they -should be placed as shown below.

- -

If not conditional on an enumerated value, switch -statements should always have a default case -(in the case of an enumerated value, the compiler will -warn you if any values are not handled). If the default -case should never execute, simply -assert:

- - - -
-
switch (var) {
-  case 0: {  // 2 space indent
-    ...      // 4 space indent
-    break;
-  }
-  case 1: {
-    ...
-    break;
-  }
-  default: {
-    assert(false);
-  }
-}
-
-
- - - - - -

Braces are optional for single-statement loops.

- -
for (int i = 0; i < kSomeNumber; ++i)
-  printf("I love you\n");
-
-for (int i = 0; i < kSomeNumber; ++i) {
-  printf("I take it back\n");
-}
-
- - -

Empty loop bodies should use {} or -continue, but not a single semicolon.

- -
while (condition) {
-  // Repeat test until it returns false.
-}
-for (int i = 0; i < kSomeNumber; ++i) {}  // Good - empty body.
-while (condition) continue;  // Good - continue indicates no logic.
-
- -
while (condition);  // Bad - looks like part of do/while loop.
-
- -
- -

Pointer and Reference Expressions

- -
-

No spaces around period or arrow. Pointer operators do not -have trailing spaces.

-
- -
- -

The following are examples of correctly-formatted -pointer and reference expressions:

- -
x = *p;
-p = &x;
-x = r.y;
-x = r->y;
-
- -

Note that:

- -
    -
  • There are no spaces around the period or arrow when - accessing a member.
    • - -
  • Pointer operators have no space after the - * or &.
    • -
- -

When declaring a pointer variable or argument, you may -place the asterisk adjacent to either the type or to the -variable name:

- -
// These are fine, space preceding.
-char *c;
-const string &str;
-
-// These are fine, space following.
-char* c;    // but remember to do "char* c, *d, *e, ...;"!
-const string& str;
-
- -
char * c;  // Bad - spaces on both sides of *
-const string & str;  // Bad - spaces on both sides of &
-
- -

You should do this consistently within a single -file, -so, when modifying an existing file, use the style in -that file.

- -
- -

Boolean Expressions

- -
-

When you have a boolean expression that is longer than the -standard line length, be -consistent in how you break up the lines.

-
- -
- -

In this example, the logical AND operator is always at -the end of the lines:

- -
if (this_one_thing > this_other_thing &&
-    a_third_thing == a_fourth_thing &&
-    yet_another && last_one) {
-  ...
-}
-
- -

Note that when the code wraps in this example, both of -the && logical AND operators are at -the end of the line. This is more common in Google code, -though wrapping all operators at the beginning of the -line is also allowed. Feel free to insert extra -parentheses judiciously because they can be very helpful -in increasing readability when used -appropriately. Also note that you should always use -the punctuation operators, such as -&& and ~, rather than -the word operators, such as and and -compl.

- -
- -

Return Values

- -
-

Do not needlessly surround the return -expression with parentheses.

-
- -
- -

Use parentheses in return expr; only -where you would use them in x = expr;.

- -
return result;                  // No parentheses in the simple case.
-// Parentheses OK to make a complex expression more readable.
-return (some_long_condition &&
-        another_condition);
-
- -
return (value);                // You wouldn't write var = (value);
-return(result);                // return is not a function!
-
- -
- - - -

Variable and Array Initialization

- -
-

Your choice of =, (), or -{}.

-
- -
- -

You may choose between =, -(), and {}; the following are -all correct:

- -
int x = 3;
-int x(3);
-int x{3};
-string name = "Some Name";
-string name("Some Name");
-string name{"Some Name"};
-
- -

Be careful when using a braced initialization list {...} -on a type with an std::initializer_list constructor. -A nonempty braced-init-list prefers the -std::initializer_list constructor whenever -possible. Note that empty braces {} are special, and -will call a default constructor if available. To force the -non-std::initializer_list constructor, use parentheses -instead of braces.

- -
vector<int> v(100, 1);  // A vector of 100 1s.
-vector<int> v{100, 1};  // A vector of 100, 1.
-
- -

Also, the brace form prevents narrowing of integral -types. This can prevent some types of programming -errors.

- -
int pi(3.14);  // OK -- pi == 3.
-int pi{3.14};  // Compile error: narrowing conversion.
-
- -
- -

Preprocessor Directives

- -
-

The hash mark that starts a preprocessor directive should -always be at the beginning of the line.

-
- -
- -

Even when preprocessor directives are within the body -of indented code, the directives should start at the -beginning of the line.

- -
// Good - directives at beginning of line
-  if (lopsided_score) {
-#if DISASTER_PENDING      // Correct -- Starts at beginning of line
-    DropEverything();
-# if NOTIFY               // OK but not required -- Spaces after #
-    NotifyClient();
-# endif
-#endif
-    BackToNormal();
-  }
-
- -
// Bad - indented directives
-  if (lopsided_score) {
-    #if DISASTER_PENDING  // Wrong!  The "#if" should be at beginning of line
-    DropEverything();
-    #endif                // Wrong!  Do not indent "#endif"
-    BackToNormal();
-  }
-
- -
- -

Class Format

- -
-

Sections in public, protected and -private order, each indented one space.

-
- -
- -

The basic format for a class declaration (lacking the -comments, see Class -Comments for a discussion of what comments are -needed) is:

- -
class MyClass : public OtherClass {
- public:      // Note the 1 space indent!
-  MyClass();  // Regular 2 space indent.
-  explicit MyClass(int var);
-  ~MyClass() {}
-
-  void SomeFunction();
-  void SomeFunctionThatDoesNothing() {
-  }
-
-  void set_some_var(int var) { some_var_ = var; }
-  int some_var() const { return some_var_; }
-
- private:
-  bool SomeInternalFunction();
-
-  int some_var_;
-  int some_other_var_;
-};
-
- -

Things to note:

- -
    -
  • Any base class name should be on the same line as - the subclass name, subject to the 80-column limit.
    • - -
  • The public:, protected:, - and private: keywords should be indented - one space.
    • - -
  • Except for the first instance, these keywords - should be preceded by a blank line. This rule is - optional in small classes.
    • - -
  • Do not leave a blank line after these - keywords.
    • - -
  • The public section should be first, - followed by the protected and finally the - private section.
    • - -
  • See Declaration - Order for rules on ordering declarations within - each of these sections.
    • -
- -
- -

Constructor Initializer Lists

- -
-

Constructor initializer lists can be all on one line or -with subsequent lines indented four spaces.

-
- -
- -

The acceptable formats for initializer lists are:

- -
// When everything fits on one line:
-MyClass::MyClass(int var) : some_var_(var) {
-  DoSomething();
-}
-
-// If the signature and initializer list are not all on one line,
-// you must wrap before the colon and indent 4 spaces:
-MyClass::MyClass(int var)
-    : some_var_(var), some_other_var_(var + 1) {
-  DoSomething();
-}
-
-// When the list spans multiple lines, put each member on its own line
-// and align them:
-MyClass::MyClass(int var)
-    : some_var_(var),             // 4 space indent
-      some_other_var_(var + 1) {  // lined up
-  DoSomething();
-}
-
-// As with any other code block, the close curly can be on the same
-// line as the open curly, if it fits.
-MyClass::MyClass(int var)
-    : some_var_(var) {}
-
- -
- -

Namespace Formatting

- -
-

The contents of namespaces are not indented.

-
- -
- -

Namespaces do not add an -extra level of indentation. For example, use:

- -
namespace {
-
-void foo() {  // Correct.  No extra indentation within namespace.
-  ...
-}
-
-}  // namespace
-
- -

Do not indent within a namespace:

- -
namespace {
-
-  // Wrong.  Indented when it should not be.
-  void foo() {
-    ...
-  }
-
-}  // namespace
-
- -

When declaring nested namespaces, put each namespace -on its own line.

- -
namespace foo {
-namespace bar {
-
- -
- -

Horizontal Whitespace

- -
-

Use of horizontal whitespace depends on location. Never put -trailing whitespace at the end of a line.

-
- -
- -

General

- -
void f(bool b) {  // Open braces should always have a space before them.
-  ...
-int i = 0;  // Semicolons usually have no space before them.
-// Spaces inside braces for braced-init-list are optional.  If you use them,
-// put them on both sides!
-int x[] = { 0 };
-int x[] = {0};
-
-// Spaces around the colon in inheritance and initializer lists.
-class Foo : public Bar {
- public:
-  // For inline function implementations, put spaces between the braces
-  // and the implementation itself.
-  Foo(int b) : Bar(), baz_(b) {}  // No spaces inside empty braces.
-  void Reset() { baz_ = 0; }  // Spaces separating braces from implementation.
-  ...
-
- -

Adding trailing whitespace can cause extra work for -others editing the same file, when they merge, as can -removing existing trailing whitespace. So: Don't -introduce trailing whitespace. Remove it if you're -already changing that line, or do it in a separate -clean-up -operation (preferably when no-one -else is working on the file).

- -

Loops and Conditionals

- -
if (b) {          // Space after the keyword in conditions and loops.
-} else {          // Spaces around else.
-}
-while (test) {}   // There is usually no space inside parentheses.
-switch (i) {
-for (int i = 0; i < 5; ++i) {
-// Loops and conditions may have spaces inside parentheses, but this
-// is rare.  Be consistent.
-switch ( i ) {
-if ( test ) {
-for ( int i = 0; i < 5; ++i ) {
-// For loops always have a space after the semicolon.  They may have a space
-// before the semicolon, but this is rare.
-for ( ; i < 5 ; ++i) {
-  ...
-
-// Range-based for loops always have a space before and after the colon.
-for (auto x : counts) {
-  ...
-}
-switch (i) {
-  case 1:         // No space before colon in a switch case.
-    ...
-  case 2: break;  // Use a space after a colon if there's code after it.
-
- -

Operators

- -
// Assignment operators always have spaces around them.
-x = 0;
-
-// Other binary operators usually have spaces around them, but it's
-// OK to remove spaces around factors.  Parentheses should have no
-// internal padding.
-v = w * x + y / z;
-v = w*x + y/z;
-v = w * (x + z);
-
-// No spaces separating unary operators and their arguments.
-x = -5;
-++x;
-if (x && !y)
-  ...
-
- -

Templates and Casts

- -
// No spaces inside the angle brackets (< and >), before
-// <, or between >( in a cast
-vector<string> x;
-y = static_cast<char*>(x);
-
-// Spaces between type and pointer are OK, but be consistent.
-vector<char *> x;
-set<list<string>> x;        // Permitted in C++11 code.
-set<list<string> > x;       // C++03 required a space in > >.
-
-// You may optionally use symmetric spacing in < <.
-set< list<string> > x;
-
- -
- -

Vertical Whitespace

- -
-

Minimize use of vertical whitespace.

-
- -
- -

This is more a principle than a rule: don't use blank -lines when you don't have to. In particular, don't put -more than one or two blank lines between functions, -resist starting functions with a blank line, don't end -functions with a blank line, and be discriminating with -your use of blank lines inside functions.

- -

The basic principle is: The more code that fits on one -screen, the easier it is to follow and understand the -control flow of the program. Of course, readability can -suffer from code being too dense as well as too spread -out, so use your judgement. But in general, minimize use -of vertical whitespace.

- -

Some rules of thumb to help when blank lines may be -useful:

- -
    -
  • Blank lines at the beginning or end of a function - very rarely help readability.
    • - -
  • Blank lines inside a chain of if-else blocks may - well help readability.
    • -
- -
- -

Exceptions to the Rules

- -

The coding conventions described above are mandatory. -However, like all good rules, these sometimes have exceptions, -which we discuss here.

- - - -
-

Existing Non-conformant Code

- -
-

You may diverge from the rules when dealing with code that -does not conform to this style guide.

-
- -
- -

If you find yourself modifying code that was written -to specifications other than those presented by this -guide, you may have to diverge from these rules in order -to stay consistent with the local conventions in that -code. If you are in doubt about how to do this, ask the -original author or the person currently responsible for -the code. Remember that consistency includes -local consistency, too.

- -
-
- - - -

Windows Code

- -
-

Windows -programmers have developed their own set of coding -conventions, mainly derived from the conventions in Windows -headers and other Microsoft code. We want to make it easy -for anyone to understand your code, so we have a single set -of guidelines for everyone writing C++ on any platform.

-
- -
-

It is worth reiterating a few of the guidelines that -you might forget if you are used to the prevalent Windows -style:

- -
    -
  • Do not use Hungarian notation (for example, naming - an integer iNum). Use the Google naming - conventions, including the .cc extension - for source files.
    • - -
  • Windows defines many of its own synonyms for - primitive types, such as DWORD, - HANDLE, etc. It is perfectly acceptable, - and encouraged, that you use these types when calling - Windows API functions. Even so, keep as close as you - can to the underlying C++ types. For example, use - const TCHAR * instead of - LPCTSTR.
    • - -
  • When compiling with Microsoft Visual C++, set the - compiler to warning level 3 or higher, and treat all - warnings as errors.
    • - -
  • Do not use #pragma once; instead use - the standard Google include guards. The path in the - include guards should be relative to the top of your - project tree.
    • - -
  • In fact, do not use any nonstandard extensions, - like #pragma and __declspec, - unless you absolutely must. Using - __declspec(dllimport) and - __declspec(dllexport) is allowed; however, - you must use them through macros such as - DLLIMPORT and DLLEXPORT, so - that someone can easily disable the extensions if they - share the code.
    • -
- -

However, there are just a few rules that we -occasionally need to break on Windows:

- -
    -
  • Normally we forbid - the use of multiple implementation inheritance; - however, it is required when using COM and some ATL/WTL - classes. You may use multiple implementation - inheritance to implement COM or ATL/WTL classes and - interfaces.
    • - -
  • Although you should not use exceptions in your own - code, they are used extensively in the ATL and some - STLs, including the one that comes with Visual C++. - When using the ATL, you should define - _ATL_NO_EXCEPTIONS to disable exceptions. - You should investigate whether you can also disable - exceptions in your STL, but if not, it is OK to turn on - exceptions in the compiler. (Note that this is only to - get the STL to compile. You should still not write - exception handling code yourself.)
    • - -
  • The usual way of working with precompiled headers - is to include a header file at the top of each source - file, typically with a name like StdAfx.h - or precompile.h. To make your code easier - to share with other projects, avoid including this file - explicitly (except in precompile.cc), and - use the /FI compiler option to include the - file automatically.
    • - -
  • Resource headers, which are usually named - resource.h and contain only macros, do not - need to conform to these style guidelines.
    • -
- -
- -

Parting Words

- -

Use common sense and BE CONSISTENT.

- -

If you are editing code, take a few minutes to look at the -code around you and determine its style. If they use spaces -around their if clauses, you should, too. If their -comments have little boxes of stars around them, make your -comments have little boxes of stars around them too.

- -

The point of having style guidelines is to have a common -vocabulary of coding so people can concentrate on what you are -saying, rather than on how you are saying it. We present global -style rules here so people know the vocabulary. But local style -is also important. If code you add to a file looks drastically -different from the existing code around it, the discontinuity -throws readers out of their rhythm when they go to read it. Try -to avoid this.

- - - -

OK, enough writing about writing code; the code itself is much -more interesting. Have fun!

- -
- -
-
- - diff --git a/cppguide.xml b/cppguide.xml deleted file mode 100644 index 8efc102..0000000 --- a/cppguide.xml +++ /dev/null @@ -1,18 +0,0 @@ - - - - - - - Redirecting - - - - Redirecting you to cppguide.html. - - diff --git a/google-r-style.html b/google-r-style.html deleted file mode 100644 index 21a73f6..0000000 --- a/google-r-style.html +++ /dev/null @@ -1,18 +0,0 @@ - - - - - - - Redirecting - - - - Redirecting you to Rguide.xml. - - diff --git a/htmlcssguide.asciidoc b/htmlcssguide.asciidoc new file mode 100644 index 0000000..b792c98 --- /dev/null +++ b/htmlcssguide.asciidoc @@ -0,0 +1,937 @@ += Google HTML/CSS Style Guide + +:sectlinks: + +Revision 2.23 + + + + + +Table of Contents + +[width="100%",cols="50%,50%",] +|===================================================================================================================================================================================================================================================================================================================================================================================================================================================== +a| +link:#general-style-rules[General Style Rules] + + a| +link:#protocol[Protocol] + +a| +link:#general-formatting-rules[General Formatting Rules] + + a| +link:#indentation[Indentation] link:#capitalization[Capitalization] link:#trailing-whitespace[Trailing Whitespace] + +a| +link:#general-meta-rules[General Meta Rules] + + a| +link:#encoding[Encoding] link:#comments[Comments] link:#action-items[Action Items] + +a| +link:#html-style-rules[HTML Style Rules] + + a| +link:#document-type[Document Type] link:#html-validity[HTML Validity] link:#semantics[Semantics] link:#multimedia-fallback[Multimedia Fallback] link:#separation-of-concerns[Separation of Concerns] link:#entity-references[Entity References] link:#optional-tags[Optional Tags] link:#type-attributes[type Attributes] + +a| +link:#html-formatting-rules[HTML Formatting Rules] + + a| +link:#general-formatting[General Formatting] link:#html-quotation-marks[HTML Quotation Marks] + +a| +link:#css-style-rules[CSS Style Rules] + + a| +link:#css-validity[CSS Validity] link:#id-and-class-naming[ID and Class Naming] link:#id-and-class-name_style[ID and Class Name Style] link:#type-selectors[Type Selectors] link:#shorthand-properties[Shorthand Properties] link:#0_and_Units[0 and Units] link:#Leading_0s[Leading 0s] link:#hexadecimal-notation[Hexadecimal Notation] link:#prefixes[Prefixes] link:#id-and-class-name_delimiters[ID and Class Name Delimiters] link:#hacks[Hacks] + +a| +link:#css-formatting-rules[CSS Formatting Rules] + + a| +link:#declaration-order[Declaration Order] link:#block-content-indentation[Block Content Indentation] link:#declaration-stops[Declaration Stops] link:#property-name-stops[Property Name Stops] link:#declaration-block-separation[Declaration Block Separation] link:#selector-and-declaration-separation[Selector and Declaration Separation] link:#rule-separation[Rule Separation] link:#css-quotation-marks[CSS Quotation Marks] + +a| +link:#css-meta-rules[CSS Meta Rules] + + a| +link:#section-comments[Section Comments] + +|===================================================================================================================================================================================================================================================================================================================================================================================================================================================== + +[[Important_Note]] +== Important Note + +=== Displaying Hidden Details in This Guide + + + +This style guide contains many details that are initially hidden from view. They are marked by the triangle icon, which you see here on your left. Click it now. You should see “Hooray” appear below. + +Hooray! Now you know you can expand points to get more details. Alternatively, there’s a “toggle all” at the top of this document. + +[[Background]] +== Background + +This document defines formatting and style rules for HTML and CSS. It aims at improving collaboration, code quality, and enabling supporting infrastructure. It applies to raw, working files that use HTML and CSS, including GSS files. Tools are free to obfuscate, minify, and compile as long as the general code quality is maintained. + +[[General_Style_Rules]] +== General Style Rules + +=== Protocol + + + +Omit the protocol from embedded resources. + +Omit the protocol portion (`http:`, `https:`) from URLs pointing to images and other media files, style sheets, and scripts unless the respective files are not available over both protocols. + +Omitting the protocol—which makes the URL relative—prevents mixed content issues and results in minor file size savings. + +---------------------------------------------------------------------------- + + +---------------------------------------------------------------------------- + +----------------------------------------------------------------------- + + +----------------------------------------------------------------------- + +-------------------------------------------------------- +/* Not recommended */ +.example { + background: url(http://www.google.com/images/example); +} +-------------------------------------------------------- + +--------------------------------------------------- +/* Recommended */ +.example { + background: url(//www.google.com/images/example); +} +--------------------------------------------------- + +[[General_Formatting_Rules]] +== General Formatting Rules + +=== Indentation + + + +Indent by 2 spaces at a time. + +Don’t use tabs or mix tabs and spaces for indentation. + +--------------- +
    +
  • Fantastic +
  • Great +
+--------------- + +-------------- +.example { + color: blue; +} +-------------- + +=== Capitalization + + + +Use only lowercase. + +All code has to be lowercase: This applies to HTML element names, attributes, attribute values (unless `text/CDATA`), CSS selectors, properties, and property values (with the exception of strings). + +------------------------ + +Home +------------------------ + +----------------------------------- + +Google +----------------------------------- + +--------------------- +/* Not recommended */ +color: #E5E5E5; +--------------------- + +----------------- +/* Recommended */ +color: #e5e5e5; +----------------- + +=== Trailing Whitespace + + + +Remove trailing white spaces. + +Trailing white spaces are unnecessary and can complicate diffs. + +------------------------ + +

What?_ +------------------------ + +-------------------- + +

Yes please. +-------------------- + +[[General_Meta_Rules]] +== General Meta Rules + +=== Encoding + + + +Use UTF-8 (no BOM). + +Make sure your editor uses UTF-8 as character encoding, without a byte order mark. + +Specify the encoding in HTML templates and documents via ``. Do not specify the encoding of style sheets as these assume UTF-8. + +(More on encodings and when and how to specify them can be found in http://www.w3.org/International/tutorials/tutorial-char-enc/[Handling character encodings in HTML and CSS].) + +=== Comments + + + +Explain code as needed, where possible. + +Use comments to explain code: What does it cover, what purpose does it serve, why is respective solution used or preferred? + +(This item is optional as it is not deemed a realistic expectation to always demand fully documented code. Mileage may vary heavily for HTML and CSS code and depends on the project’s complexity.) + +=== Action Items + + + +Mark todos and action items with `TODO`. + +Highlight todos by using the keyword `TODO` only, not other common formats like `@@`. + +Append a contact (username or mailing list) in parentheses as with the format `TODO(contact)`. + +Append action items after a colon as in `TODO: action item`. + +--------------------------------------- +{# TODO(john.doe): revisit centering #} +

Test
+--------------------------------------- + +----------------------------------- + +
    +
  • Apples
    • +
  • Oranges
    • +
+----------------------------------- + +[[HTML_Style_Rules]] +== HTML Style Rules + +=== Document Type + + + +Use HTML5. + +HTML5 (HTML syntax) is preferred for all HTML documents: ``. + +(It’s recommended to use HTML, as `text/html`. Do not use XHTML. XHTML, as http://hixie.ch/advocacy/xhtml[`application/xhtml+xml`], lacks both browser and infrastructure support and offers less room for optimization than HTML.) + +Although fine with HTML, do not close void elements, i.e. write `
`, not `
`. + +=== HTML Validity + + + +Use valid HTML where possible. + +Use valid HTML code unless that is not possible due to otherwise unattainable performance goals regarding file size. + +Use tools such as the http://validator.w3.org/nu/[W3C HTML validator] to test. + +Using valid HTML is a measurable baseline quality attribute that contributes to learning about technical requirements and constraints, and that ensures proper HTML usage. + +----------------------------- + +Test +
This is only a test. +----------------------------- + +--------------------------------------- + + + +Test +
This is only a test.
+--------------------------------------- + +=== Semantics + + + +Use HTML according to its purpose. + +Use elements (sometimes incorrectly called “tags”) for what they have been created for. For example, use heading elements for headings, `p` elements for paragraphs, `a` elements for anchors, etc. + +Using HTML according to its purpose is important for accessibility, reuse, and code efficiency reasons. + +--------------------------------------------------------------- + +
All recommendations
+--------------------------------------------------------------- + +-------------------------------------------------- + +All recommendations +-------------------------------------------------- + +=== Multimedia Fallback + + + +Provide alternative contents for multimedia. + +For multimedia, such as images, videos, animated objects via `canvas`, make sure to offer alternative access. For images that means use of meaningful alternative text (`alt`) and for video and audio transcripts and captions, if available. + +Providing alternative contents is important for accessibility reasons: A blind user has few cues to tell what an image is about without `@alt`, and other users may have no way of understanding what video or audio contents are about either. + +(For images whose `alt` attributes would introduce redundancy, and for images whose purpose is purely decorative which you cannot immediately use CSS for, use no alternative text, as in `alt=""`.) + +--------------------------- + + +--------------------------- + +--------------------------------------------------------- + +Spreadsheet screenshot. +--------------------------------------------------------- + +=== Separation of Concerns + + + +Separate structure from presentation from behavior. + +Strictly keep structure (markup), presentation (styling), and behavior (scripting) apart, and try to keep the interaction between the three to an absolute minimum. + +That is, make sure documents and templates contain only HTML and HTML that is solely serving structural purposes. Move everything presentational into style sheets, and everything behavioral into scripts. + +In addition, keep the contact area as small as possible by linking as few style sheets and scripts as possible from documents and templates. + +Separating structure from presentation from behavior is important for maintenance reasons. It is always more expensive to change HTML documents and templates than it is to update style sheets and scripts. + +---------------------------------------------------------------- + + +HTML sucks + + + +

HTML sucks

+

I’ve read about this on a few sites but now I’m sure: + HTML is stupid!!1 +

I can’t believe there’s no way to control the styling of + my website without doing everything all over again!
+---------------------------------------------------------------- + +-------------------------------------------------------------------- + + +My first CSS-only redesign + +

My first CSS-only redesign

+

I’ve read about this on a few sites but today I’m actually + doing it: separating concerns and avoiding anything in the HTML of + my website that is presentational. +

It’s awesome! +-------------------------------------------------------------------- + +=== Entity References + + + +Do not use entity references. + +There is no need to use entity references like `—`, `”`, or `☺`, assuming the same encoding (UTF-8) is used for files and editors as well as among teams. + +The only exceptions apply to characters with special meaning in HTML (like `<` and `&`) as well as control or “invisible” characters (like no-break spaces). + +-------------------------------------------------------- + +The currency symbol for the Euro is “&eur;”. +-------------------------------------------------------- + +---------------------------------------- + +The currency symbol for the Euro is “€”. +---------------------------------------- + +=== Optional Tags + + + +Omit optional tags (optional). + +For file size optimization and scannability purposes, consider omitting optional tags. The http://www.whatwg.org/specs/web-apps/current-work/multipage/syntax.html#syntax-tag-omission[HTML5 specification] defines what tags can be omitted. + +(This approach may require a grace period to be established as a wider guideline as it’s significantly different from what web developers are typically taught. For consistency and simplicity reasons it’s best served omitting all optional tags, not just a selection.) + +------------------------------------------------- + + + + + Spending money, spending bytes + + +

Sic.

+ + +------------------------------------------------- + +----------------------------------------- + + +Saving money, saving bytes +

Qed. +----------------------------------------- + +=== type Attributes + + + +Omit `type` attributes for style sheets and scripts. + +Do not use `type` attributes for style sheets (unless not using CSS) and scripts (unless not using JavaScript). + +Specifying `type` attributes in these contexts is not necessary as HTML5 implies http://www.whatwg.org/specs/web-apps/current-work/multipage/semantics.html#attr-style-type[`text/css`] and http://www.whatwg.org/specs/web-apps/current-work/multipage/scripting-1.html#attr-script-type[`text/javascript`] as defaults. This can be safely done even for older browsers. + +----------------------------------------------------------- + + +----------------------------------------------------------- + +------------------------------------------------------------ + + +------------------------------------------------------------ + +------------------------------------------------------------- + + +------------------------------------------------------------- + +----------------------------------------------------------------------- + + +----------------------------------------------------------------------- + +[[HTML_Formatting_Rules]] +== HTML Formatting Rules + +=== General Formatting + + + +Use a new line for every block, list, or table element, and indent every such child element. + +Independent of the styling of an element (as CSS allows elements to assume a different role per `display` property), put every block, list, or table element on a new line. + +Also, indent them if they are child elements of a block, list, or table element. + +(If you run into issues around whitespace between list items it’s acceptable to put all `li` elements in one line. A linter is encouraged to throw a warning instead of an error.) + +-------------------------------------------- +

+

Space, the final frontier.

+
+-------------------------------------------- + +----------- +
    +
  • Moe +
  • Larry +
  • Curly +
+----------- + +---------------------------- + + + + + +
Income + Taxes +
$ 5.00 + $ 4.50 +
+---------------------------- + +=== HTML Quotation Marks + + + +When quoting attributes values, use double quotation marks. + +Use double (`""`) rather than single quotation marks (`''`) around attribute values. + +-------------------------------------------------------- + +Sign in +-------------------------------------------------------- + +-------------------------------------------------------- + +Sign in +-------------------------------------------------------- + +[[CSS_Style_Rules]] +== CSS Style Rules + +=== CSS Validity + + + +Use valid CSS where possible. + +Unless dealing with CSS validator bugs or requiring proprietary syntax, use valid CSS code. + +Use tools such as the http://jigsaw.w3.org/css-validator/[W3C CSS validator] to test. + +Using valid CSS is a measurable baseline quality attribute that allows to spot CSS code that may not have any effect and can be removed, and that ensures proper CSS usage. + +=== ID and Class Naming + + + +Use meaningful or generic ID and class names. + +Instead of presentational or cryptic names, always use ID and class names that reflect the purpose of the element in question, or that are otherwise generic. + +Names that are specific and reflect the purpose of the element should be preferred as these are most understandable and the least likely to change. + +Generic names are simply a fallback for elements that have no particular or no meaning different from their siblings. They are typically needed as “helpers.” + +Using functional or generic names reduces the probability of unnecessary document or template changes. + +------------------------------------- +/* Not recommended: meaningless */ +#yee-1901 {} + +/* Not recommended: presentational */ +.button-green {} +.clear {} +------------------------------------- + +--------------------------- +/* Recommended: specific */ +#gallery {} +#login {} +.video {} + +/* Recommended: generic */ +.aux {} +.alt {} +--------------------------- + +=== ID and Class Name Style + + + +Use ID and class names that are as short as possible but as long as necessary. + +Try to convey what an ID or class is about while being as brief as possible. + +Using ID and class names this way contributes to acceptable levels of understandability and code efficiency. + +--------------------- +/* Not recommended */ +#navigation {} +.atr {} +--------------------- + +----------------- +/* Recommended */ +#nav {} +.author {} +----------------- + +=== Type Selectors + + + +Avoid qualifying ID and class names with type selectors. + +Unless necessary (for example with helper classes), do not use element names in conjunction with IDs or classes. + +Avoiding unnecessary ancestor selectors is useful for http://www.stevesouders.com/blog/2009/06/18/simplifying-css-selectors/[performance reasons]. + +--------------------- +/* Not recommended */ +ul#example {} +div.error {} +--------------------- + +----------------- +/* Recommended */ +#example {} +.error {} +----------------- + +=== Shorthand Properties + + + +Use shorthand properties where possible. + +CSS offers a variety of http://www.w3.org/TR/CSS21/about.html#shorthand[shorthand] properties (like `font`) that should be used whenever possible, even in cases where only one value is explicitly set. + +Using shorthand properties is useful for code efficiency and understandability. + +-------------------------------------- +/* Not recommended */ +border-top-style: none; +font-family: palatino, georgia, serif; +font-size: 100%; +line-height: 1.6; +padding-bottom: 2em; +padding-left: 1em; +padding-right: 1em; +padding-top: 0; +-------------------------------------- + +---------------------------------------- +/* Recommended */ +border-top: 0; +font: 100%/1.6 palatino, georgia, serif; +padding: 0 1em 2em; +---------------------------------------- + +=== 0 and Units + + + +Omit unit specification after “0” values. + +Do not use units after `0` values unless they are required. + +----------- +margin: 0; +padding: 0; +----------- + +=== Leading 0s + + + +Omit leading “0”s in values. + +Do not use put `0`s in front of values or lengths between -1 and 1. + +---------------- +font-size: .8em; +---------------- + +=== Hexadecimal Notation + + + +Use 3 character hexadecimal notation where possible. + +For color values that permit it, 3 character hexadecimal notation is shorter and more succinct. + +--------------------- +/* Not recommended */ +color: #eebbcc; +--------------------- + +----------------- +/* Recommended */ +color: #ebc; +----------------- + +=== Prefixes + + + +Prefix selectors with an application-specific prefix (optional). + +In large projects as well as for code that gets embedded in other projects or on external sites use prefixes (as namespaces) for ID and class names. Use short, unique identifiers followed by a dash. + +Using namespaces helps preventing naming conflicts and can make maintenance easier, for example in search and replace operations. + +-------------------------- +.adw-help {} /* AdWords */ +#maia-note {} /* Maia */ +-------------------------- + +=== ID and Class Name Delimiters + + + +Separate words in ID and class names by a hyphen. + +Do not concatenate words and abbreviations in selectors by any characters (including none at all) other than hyphens, in order to improve understanding and scannability. + +--------------------------------------------------------------------- +/* Not recommended: does not separate the words “demo” and “image” */ +.demoimage {} + +/* Not recommended: uses underscore instead of hyphen */ +.error_status {} +--------------------------------------------------------------------- + +----------------- +/* Recommended */ +#video-id {} +.ads-sample {} +----------------- + +=== Hacks + + + +Avoid user agent detection as well as CSS “hacks”—try a different approach first. + +It’s tempting to address styling differences over user agent detection or special CSS filters, workarounds, and hacks. Both approaches should be considered last resort in order to achieve and maintain an efficient and manageable code base. Put another way, giving detection and hacks a free pass will hurt projects in the long run as projects tend to take the way of least resistance. That is, allowing and making it easy to use detection and hacks means using detection and hacks more frequently—and more frequently is too frequently. + +[[CSS_Formatting_Rules]] +== CSS Formatting Rules + +=== Declaration Order + + + +Alphabetize declarations. + +Put declarations in alphabetical order in order to achieve consistent code in a way that is easy to remember and maintain. + +Ignore vendor-specific prefixes for sorting purposes. However, multiple vendor-specific prefixes for a certain CSS property should be kept sorted (e.g. -moz prefix comes before -webkit). + +--------------------------- +background: fuchsia; +border: 1px solid; +-moz-border-radius: 4px; +-webkit-border-radius: 4px; +border-radius: 4px; +color: black; +text-align: center; +text-indent: 2em; +--------------------------- + +=== Block Content Indentation + + + +Indent all block content. + +Indent all http://www.w3.org/TR/CSS21/syndata.html#block[block content], that is rules within rules as well as declarations, so to reflect hierarchy and improve understanding. + +--------------------------- +@media screen, projection { + + html { + background: #fff; + color: #444; + } + +} +--------------------------- + +=== Declaration Stops + + + +Use a semicolon after every declaration. + +End every declaration with a semicolon for consistency and extensibility reasons. + +--------------------- +/* Not recommended */ +.test { + display: block; + height: 100px +} +--------------------- + +----------------- +/* Recommended */ +.test { + display: block; + height: 100px; +} +----------------- + +=== Property Name Stops + + + +Use a space after a property name’s colon. + +Always use a single space between property and value (but no space between property and colon) for consistency reasons. + +--------------------- +/* Not recommended */ +h3 { + font-weight:bold; +} +--------------------- + +-------------------- +/* Recommended */ +h3 { + font-weight: bold; +} +-------------------- + +=== Declaration Block Separation + + + +Use a space between the last selector and the declaration block. + +Always use a single space between the last selector and the opening brace that begins the http://www.w3.org/TR/CSS21/syndata.html#rule-sets[declaration block]. + +The opening brace should be on the same line as the last selector in a given rule. + +--------------------------------------------- +/* Not recommended: missing space */ +#video{ + margin-top: 1em; +} + +/* Not recommended: unnecessary line break */ +#video +{ + margin-top: 1em; +} +--------------------------------------------- + +------------------ +/* Recommended */ +#video { + margin-top: 1em; +} +------------------ + +=== Selector and Declaration Separation + + + +Separate selectors and declarations by new lines. + +Always start a new line for each selector and declaration. + +------------------------------- +/* Not recommended */ +a:focus, a:active { + position: relative; top: 1px; +} +------------------------------- + +---------------------- +/* Recommended */ +h1, +h2, +h3 { + font-weight: normal; + line-height: 1.2; +} +---------------------- + +=== Rule Separation + + + +Separate rules by new lines. + +Always put a blank line (two line breaks) between rules. + +------------------- +html { + background: #fff; +} + +body { + margin: auto; + width: 50%; +} +------------------- + +=== CSS Quotation Marks + + + +Use single quotation marks for attribute selectors and property values. + +Use single (`''`) rather than double (`""`) quotation marks for attribute selectors or property values. Do not use quotation marks in URI values (`url()`). + +Exception: If you do need to use the `@charset` rule, use double quotation marks—http://www.w3.org/TR/CSS21/syndata.html#charset[single quotation marks are not permitted]. + +---------------------------------------------- +/* Not recommended */ +@import url("//www.google.com/css/maia.css"); + +html { + font-family: "open sans", arial, sans-serif; +} +---------------------------------------------- + +---------------------------------------------- +/* Recommended */ +@import url(//www.google.com/css/maia.css); + +html { + font-family: 'open sans', arial, sans-serif; +} +---------------------------------------------- + +[[CSS_Meta_Rules]] +== CSS Meta Rules + +=== Section Comments + + + +Group sections by a section comment (optional). + +If possible, group style sheet sections together by using comments. Separate sections with new lines. + +--------------- +/* Header */ + +#adw-header {} + +/* Footer */ + +#adw-footer {} + +/* Gallery */ + +.adw-gallery {} +--------------- + +== Parting Words + +_Be consistent._ + +If you’re editing code, take a few minutes to look at the code around you and determine its style. If they use spaces around all their arithmetic operators, you should too. If their comments have little boxes of hash marks around them, make your comments have little boxes of hash marks around them too. + +The point of having style guidelines is to have a common vocabulary of coding so people can concentrate on what you’re saying rather than on how you’re saying it. We present global style rules here so people know the vocabulary, but local style is also important. If code you add to a file looks drastically different from the existing code around it, it throws readers out of their rhythm when they go to read it. Avoid this. + +Revision 2.23 diff --git a/htmlcssguide.xml b/htmlcssguide.xml deleted file mode 100644 index d8caf13..0000000 --- a/htmlcssguide.xml +++ /dev/null @@ -1,1117 +0,0 @@ - - - -

- - Revision 2.23 -

- - - - - - This style guide contains many details that are initially - hidden from view. They are marked by the triangle icon, which you - see here on your left. Click it now. - You should see “Hooray” appear below. - - -

- Hooray! Now you know you can expand points to get more - details. Alternatively, there’s a “toggle all” at the - top of this document. -

- - - - - -

- This document defines formatting and style rules for HTML and - CSS. It aims at improving collaboration, code quality, and - enabling supporting infrastructure. It applies to raw, - working files that use HTML and CSS, including GSS - files. Tools are free to obfuscate, minify, and compile as - long as the general code quality is maintained. -

- - - - - - - - - Omit the protocol from embedded resources. - - -

- Omit the protocol portion (http:, - https:) from URLs pointing to images and other - media files, style sheets, and scripts unless the respective - files are not available over both protocols. -

-

- Omitting the protocol—which makes the URL - relative—prevents mixed content issues and results in - minor file size savings. -

- - <!-- Not recommended --> - <script src="http://www.google.com/js/gweb/analytics/autotrack.js"></script> - - - <!-- Recommended --> - <script src="//www.google.com/js/gweb/analytics/autotrack.js"></script> - - - /* Not recommended */ - .example { - background: url(http://www.google.com/images/example); - } - - - /* Recommended */ - .example { - background: url(//www.google.com/images/example); - } - - - - - - - - - - Indent by 2 spaces at a time. - - -

- Don’t use tabs or mix tabs and spaces for indentation. -

- - <ul> - <li>Fantastic - <li>Great - </ul> - - - .example { - color: blue; - } - - - - - - Use only lowercase. - - -

- All code has to be lowercase: This applies to HTML element names, - attributes, attribute values (unless - text/CDATA), CSS selectors, properties, and - property values (with the exception of strings). -

- - <!-- Not recommended --> - <A HREF="/">Home</A> - - - <!-- Recommended --> - <img src="google.png" alt="Google"> - - - /* Not recommended */ - color: #E5E5E5; - - - /* Recommended */ - color: #e5e5e5; - - - - - - Remove trailing white spaces. - - -

- Trailing white spaces are unnecessary and can complicate - diffs. -

- - <!-- Not recommended --> - <p>What?_ - - - <!-- Recommended --> - <p>Yes please. - - - - - - - - - Use UTF-8 (no BOM). - - -

- Make sure your editor uses UTF-8 as character encoding, - without a byte order mark. -

-

- Specify the encoding in HTML templates and documents via - <meta charset="utf-8">. Do not specify - the encoding of style sheets as these assume UTF-8. -

-

- (More on encodings and when and how to specify them can be - found in Handling - character encodings in HTML and CSS.) -

- - - - - Explain code as needed, where possible. - - -

- Use comments to explain code: What does it cover, what - purpose does it serve, why is respective solution used or - preferred? -

-

- (This item is optional as it is not deemed a realistic - expectation to always demand fully documented code. Mileage - may vary heavily for HTML and CSS code and depends on the - project’s complexity.) -

- - - - - Mark todos and action items with TODO. - - -

- Highlight todos by using the keyword TODO only, - not other common formats like @@. -

-

- Append a contact (username or mailing list) in parentheses - as with the format TODO(contact). -

-

- Append action items after a colon as in TODO: action - item. -

- - - {# TODO(john.doe): revisit centering #} - <center>Test</center> - - - - <!-- TODO: remove optional tags --> - <ul> - <li>Apples</li> - <li>Oranges</li> - </ul> - - - - - - - - - Use HTML5. - - -

- HTML5 (HTML syntax) is preferred for all HTML documents: - <!DOCTYPE html>. -

-

- (It’s recommended to use HTML, as text/html. Do not use - XHTML. XHTML, as application/xhtml+xml, - lacks both browser and infrastructure support and offers - less room for optimization than HTML.) -

-

- Although fine with HTML, do not close void elements, i.e. write - <br>, not <br />. -

- - - - - Use valid HTML where possible. - - -

- Use valid HTML code unless that is not possible due to - otherwise unattainable performance goals regarding file size. -

- -

- Use tools such as the W3C - HTML validator to test. -

-

- Using valid HTML is a measurable baseline quality attribute - that contributes to learning about technical requirements - and constraints, and that ensures proper HTML usage. -

- - <!-- Not recommended --> - <title>Test</title> - <article>This is only a test. - - - <!-- Recommended --> - <!DOCTYPE html> - <meta charset="utf-8"> - <title>Test</title> - <article>This is only a test.</article> - - - - - - Use HTML according to its purpose. - - -

- Use elements (sometimes incorrectly called “tags”) for what - they have been created for. For example, use heading - elements for headings, p elements for - paragraphs, a elements for anchors, etc. -

-

- Using HTML according to its purpose is important for - accessibility, reuse, and code efficiency reasons. -

- - - <!-- Not recommended --> - <div onclick="goToRecommendations();">All recommendations</div> - - - <!-- Recommended --> - <a href="recommendations/">All recommendations</a> - - - - - - Provide alternative contents for multimedia. - - -

- For multimedia, such as images, videos, animated objects via - canvas, make sure to offer alternative - access. For images that means use of meaningful alternative - text (alt) and for video and audio transcripts - and captions, if available. -

-

- Providing alternative contents is important for - accessibility reasons: A blind user has few cues to tell - what an image is about without @alt, and other - users may have no way of understanding what video or audio - contents are about either. -

-

- (For images whose alt attributes would - introduce redundancy, and for images whose purpose is purely - decorative which you cannot immediately use CSS for, use no - alternative text, as in alt="".) -

- - - <!-- Not recommended --> - <img src="spreadsheet.png"> - - - <!-- Recommended --> - <img src="spreadsheet.png" alt="Spreadsheet screenshot."> - - - - - - - Separate structure from presentation from behavior. - - -

- Strictly keep structure (markup), presentation (styling), - and behavior (scripting) apart, and try to keep the - interaction between the three to an absolute minimum. -

-

- That is, make sure documents and templates contain only HTML - and HTML that is solely serving structural purposes. Move - everything presentational into style sheets, and everything - behavioral into scripts. -

-

- In addition, keep the contact area as small as possible by - linking as few style sheets and scripts as possible from - documents and templates. -

-

- Separating structure from presentation from behavior is - important for maintenance reasons. It is always more - expensive to change HTML documents and templates than it is - to update style sheets and scripts. -

- - - <!-- Not recommended --> - <!DOCTYPE html> - <title>HTML sucks</title> - <link rel="stylesheet" href="base.css" media="screen"> - <link rel="stylesheet" href="grid.css" media="screen"> - <link rel="stylesheet" href="print.css" media="print"> - <h1 style="font-size: 1em;">HTML sucks</h1> - <p>I’ve read about this on a few sites but now I’m sure: - <u>HTML is stupid!!1</u> - <center>I can’t believe there’s no way to control the styling of - my website without doing everything all over again!</center> - - - <!-- Recommended --> - <!DOCTYPE html> - <title>My first CSS-only redesign</title> - <link rel="stylesheet" href="default.css"> - <h1>My first CSS-only redesign</h1> - <p>I’ve read about this on a few sites but today I’m actually - doing it: separating concerns and avoiding anything in the HTML of - my website that is presentational. - <p>It’s awesome! - - - - - - Do not use entity references. - - -

- There is no need to use entity references like - &mdash;, &rdquo;, or - &#x263a;, assuming the same encoding - (UTF-8) is used for files and editors as well as among - teams. -

-

- The only exceptions apply to characters with special meaning - in HTML (like < and &) as - well as control or “invisible” characters (like no-break - spaces). -

- - <!-- Not recommended --> - The currency symbol for the Euro is &ldquo;&eur;&rdquo;. - - - <!-- Recommended --> - The currency symbol for the Euro is “€”. - - - - - - Omit optional tags (optional). - - -

- For file size optimization and scannability purposes, - consider omitting optional tags. - The HTML5 - specification defines what tags can be omitted. -

-

- (This approach may require a grace period to be established - as a wider guideline as it’s significantly different - from what web developers are typically taught. For - consistency and simplicity reasons it’s best served - omitting all optional tags, not just a selection.) -

- - <!-- Not recommended --> - <!DOCTYPE html> - <html> - <head> - <title>Spending money, spending bytes</title> - </head> - <body> - <p>Sic.</p> - </body> - </html> - - - <!-- Recommended --> - <!DOCTYPE html> - <title>Saving money, saving bytes</title> - <p>Qed. - - - - - - Omit type attributes for style sheets and scripts. - - -

- Do not use type attributes for style sheets - (unless not using CSS) and scripts (unless not using - JavaScript). -

-

- Specifying type attributes in these contexts is - not necessary as HTML5 implies - text/css - and - text/javascript - as defaults. This can be safely done even for older browsers. -

- - <!-- Not recommended --> - <link rel="stylesheet" href="//www.google.com/css/maia.css" - type="text/css"> - - - <!-- Recommended --> - <link rel="stylesheet" href="//www.google.com/css/maia.css"> - - - <!-- Not recommended --> - <script src="//www.google.com/js/gweb/analytics/autotrack.js" - type="text/javascript"></script> - - - <!-- Recommended --> - <script src="//www.google.com/js/gweb/analytics/autotrack.js"></script> - - - - - - - - - Use a new line for every block, list, or table element, and - indent every such child element. - - -

- Independent of the styling of an element (as CSS allows - elements to assume a different role per display - property), put every block, list, or table element on a new - line. -

-

- Also, indent them if they are child elements of a block, - list, or table element. -

-

- (If you run into issues around whitespace between list items - it’s acceptable to put all li elements in one - line. A linter is encouraged to throw a warning instead of - an error.) -

- - <blockquote> - <p><em>Space</em>, the final frontier.</p> - </blockquote> - - - <ul> - <li>Moe - <li>Larry - <li>Curly - </ul> - - - <table> - <thead> - <tr> - <th scope="col">Income - <th scope="col">Taxes - <tbody> - <tr> - <td>$ 5.00 - <td>$ 4.50 - </table> - - - - - - When quoting attributes values, use double quotation marks. - - -

- Use double ("") rather than single quotation marks - ('') around attribute values. -

- - <!-- Not recommended --> - <a class='maia-button maia-button-secondary'>Sign in</a> - - - <!-- Recommended --> - <a class="maia-button maia-button-secondary">Sign in</a> - - - - - - - - - Use valid CSS where possible. - - -

- Unless dealing with CSS validator bugs or requiring - proprietary syntax, use valid CSS code. -

- -

- Use tools such as the W3C - CSS validator to test. -

-

- Using valid CSS is a measurable baseline quality attribute - that allows to spot CSS code that may not have any effect - and can be removed, and that ensures proper CSS usage. -

- - - - - Use meaningful or generic ID and class names. - - -

- Instead of presentational or cryptic names, always use ID - and class names that reflect the purpose of the element in - question, or that are otherwise generic. -

-

- Names that are specific and reflect the purpose of the - element should be preferred as these are most understandable - and the least likely to change. -

-

- Generic names are simply a fallback for elements that have no - particular or no meaning different from their siblings. They are - typically needed as “helpers.” -

-

- Using functional or generic names reduces the probability of - unnecessary document or template changes. -

- - /* Not recommended: meaningless */ - #yee-1901 {} - - /* Not recommended: presentational */ - .button-green {} - .clear {} - - - /* Recommended: specific */ - #gallery {} - #login {} - .video {} - - /* Recommended: generic */ - .aux {} - .alt {} - - - - - - Use ID and class names that are as short as possible but as long as - necessary. - - -

- Try to convey what an ID or class is about while being as - brief as possible. -

-

- Using ID and class names this way contributes to acceptable - levels of understandability and code efficiency. -

- - /* Not recommended */ - #navigation {} - .atr {} - - - /* Recommended */ - #nav {} - .author {} - - - - - - - Avoid qualifying ID and class names with type selectors. - - -

Unless necessary (for example with helper classes), do not - use element names in conjunction with IDs or classes. -

-

- Avoiding unnecessary ancestor selectors is useful for performance - reasons. -

- - /* Not recommended */ - ul#example {} - div.error {} - - - /* Recommended */ - #example {} - .error {} - - - - - - Use shorthand properties where possible. - - -

- CSS offers a variety of shorthand - properties (like font) - that should be used whenever possible, even in cases where - only one value is explicitly set. -

-

- Using shorthand properties is useful for code efficiency and - understandability. -

- - /* Not recommended */ - border-top-style: none; - font-family: palatino, georgia, serif; - font-size: 100%; - line-height: 1.6; - padding-bottom: 2em; - padding-left: 1em; - padding-right: 1em; - padding-top: 0; - - - /* Recommended */ - border-top: 0; - font: 100%/1.6 palatino, georgia, serif; - padding: 0 1em 2em; - - - - - - Omit unit specification after “0” values. - - -

- Do not use units after 0 values unless they are - required. -

- - margin: 0; - padding: 0; - - - - - - Omit leading “0”s in values. - - -

- Do not use put 0s in front of values or lengths - between -1 and 1. -

- - font-size: .8em; - - - - - - Use 3 character hexadecimal notation where possible. - - -

- For color values that permit it, 3 character hexadecimal - notation is shorter and more succinct. -

- - /* Not recommended */ - color: #eebbcc; - - - /* Recommended */ - color: #ebc; - - - - - - Prefix selectors with an application-specific prefix (optional). - - -

- In large projects as well as for code that gets embedded in - other projects or on external sites use prefixes (as - namespaces) for ID and class names. Use short, unique - identifiers followed by a dash. -

- - -

- Using namespaces helps preventing naming conflicts and can - make maintenance easier, for example in search and replace - operations. -

- - .adw-help {} /* AdWords */ - #maia-note {} /* Maia */ - - - - - - Separate words in ID and class names by a hyphen. - - -

- Do not concatenate words and abbreviations in selectors by - any characters (including none at all) other than hyphens, - in order to improve understanding and scannability. -

- - /* Not recommended: does not separate the words “demo” and “image” */ - .demoimage {} - - /* Not recommended: uses underscore instead of hyphen */ - .error_status {} - - - /* Recommended */ - #video-id {} - .ads-sample {} - - - - - - Avoid user agent detection as well as CSS “hacks”—try a different - approach first. - - -

- It’s tempting to address styling differences over user - agent detection or special CSS filters, workarounds, and - hacks. Both approaches should be considered last resort in - order to achieve and maintain an efficient and manageable - code base. Put another way, giving detection and hacks a - free pass will hurt projects in the long run as projects - tend to take the way of least resistance. That is, allowing - and making it easy to use detection and hacks means using - detection and hacks more frequently—and more frequently - is too frequently. -

- - - - - - - - - - Alphabetize declarations. - - -

- Put declarations in alphabetical order in order to achieve - consistent code in a way that is easy to remember and - maintain. -

-

- Ignore vendor-specific prefixes for sorting purposes. However, - multiple vendor-specific prefixes for a certain CSS property should - be kept sorted (e.g. -moz prefix comes before -webkit). -

- - background: fuchsia; - border: 1px solid; - -moz-border-radius: 4px; - -webkit-border-radius: 4px; - border-radius: 4px; - color: black; - text-align: center; - text-indent: 2em; - - - - - - Indent all block content. - - -

- Indent all block - content, that is rules within rules as well as declarations, so to - reflect hierarchy and improve understanding. -

- - @media screen, projection { - - html { - background: #fff; - color: #444; - } - - } - - - - - - Use a semicolon after every declaration. - - -

- End every declaration with a semicolon for consistency and - extensibility reasons. -

- - /* Not recommended */ - .test { - display: block; - height: 100px - } - - - /* Recommended */ - .test { - display: block; - height: 100px; - } - - - - - - Use a space after a property name’s colon. - - -

- Always use a single space between property and value (but no - space between property and colon) for consistency reasons. -

- - /* Not recommended */ - h3 { - font-weight:bold; - } - - - /* Recommended */ - h3 { - font-weight: bold; - } - - - - - - Use a space between the last selector and the declaration block. - - -

- Always use a single space between the last selector and the opening - brace that begins the declaration - block. -

-

- The opening brace should be on the same line as the last selector in a - given rule. -

- - /* Not recommended: missing space */ - #video{ - margin-top: 1em; - } - - /* Not recommended: unnecessary line break */ - #video - { - margin-top: 1em; - } - - - /* Recommended */ - #video { - margin-top: 1em; - } - - - - - - Separate selectors and declarations by new lines. - - -

- Always start a new line for each selector and declaration. -

- - /* Not recommended */ - a:focus, a:active { - position: relative; top: 1px; - } - - - /* Recommended */ - h1, - h2, - h3 { - font-weight: normal; - line-height: 1.2; - } - - - - - - Separate rules by new lines. - - -

- Always put a blank line (two line breaks) between rules. -

- - html { - background: #fff; - } - - body { - margin: auto; - width: 50%; - } - - - - - - Use single quotation marks for attribute selectors and property values. - - -

- Use single ('') rather than double ("") - quotation marks for attribute selectors or property values. Do not - use quotation marks in URI values (url()). -

-

- Exception: If you do need to use the @charset rule, - use double quotation marks—single - quotation marks are not permitted. -

- - /* Not recommended */ - @import url("//www.google.com/css/maia.css"); - - html { - font-family: "open sans", arial, sans-serif; - } - - - /* Recommended */ - @import url(//www.google.com/css/maia.css); - - html { - font-family: 'open sans', arial, sans-serif; - } - - - - - - - - - - Group sections by a section comment (optional). - - -

- If possible, group style sheet sections together by using - comments. Separate sections with new lines. -

- - /* Header */ - - #adw-header {} - - /* Footer */ - - #adw-footer {} - - /* Gallery */ - - .adw-gallery {} - - - - - - - - -

- Be consistent. -

-

- If you’re editing code, take a few minutes to look at the code - around you and determine its style. If they use spaces around - all their arithmetic operators, you should too. If their - comments have little boxes of hash marks around them, make your - comments have little boxes of hash marks around them too. -

-

- The point of having style guidelines is to have a common vocabulary - of coding so people can concentrate on what you’re saying rather - than on how you’re saying it. We present global style rules here so - people know the vocabulary, but local style is also important. If - code you add to a file looks drastically different from the existing - code around it, it throws readers out of their rhythm when they go to - read it. Avoid this. -

- - -

- Revision 2.23 -

- - diff --git a/javaguide.asciidoc b/javaguide.asciidoc new file mode 100644 index 0000000..25123c6 --- /dev/null +++ b/javaguide.asciidoc @@ -0,0 +1,847 @@ += Google Java Style + +Last changed: March 21, 2014 + +[width="100%",cols="34%,33%,33%",] +|=========================================================================================== +a| + link:#s1-introduction[1 Introduction] :: + link:#s1.1-terminology[1.1 Terminology notes] + + + link:#s1.2-guide-notes[1.2 Guide notes] + link:#s2-source-file-basics[2 Source file basics] :: + link:#s2.1-file-name[2.1 File name] + + + link:#s2.2-file-encoding[2.2 File encoding: UTF-8] + + + link:#s2.3-special-characters[2.3 Special characters] + + + link:#s2.3.1-whitespace-characters[2.3.1 Whitespace characters] + + + link:#s2.3.2-special-escape-sequences[2.3.2 Special escape sequences] + + + link:#s2.3.3-non-ascii-characters[2.3.3 Non-ASCII characters] + link:#s3-source-file-structure[3 Source file structure] :: + link:#s3.1-copyright-statement[3.1 License or copyright information, if present] + + + link:#s3.2-package-statement[3.2 Package statement] + + + link:#s3.3-import-statements[3.3 Import statements] + + + link:#s3.3.1-wildcard-imports[3.3.1 No wildcard imports] + + + link:#s3.3.2-import-line-wrapping[3.3.2 No line-wrapping] + + + link:#s3.3.3-import-ordering-and-spacing[3.3.3 Ordering and spacing] + + + link:#s3.4-class-declaration[3.4 Class declaration] + + + link:#s3.4.1-one-top-level-class[3.4.1 Exactly one top-level class declaration] + + + link:#s3.4.2-class-member-ordering[3.4.2 Class member ordering] + + a| + link:#s4-formatting[4 Formatting] :: + link:#s4.1-braces[4.1 Braces] + + + link:#s4.1.1-braces-always-used[4.1.1 Braces are used where optional] + + + link:#s4.1.2-blocks-k-r-style[4.1.2 Nonempty blocks: K & R style] + + + link:#s4.1.3-braces-empty-blocks[4.1.3 Empty blocks: may be concise] + + + link:#s4.2-block-indentation[4.2 Block indentation: +2 spaces] + + + link:#s4.3-one-statement-per-line[4.3 One statement per line] + + + link:#s4.4-column-limit[4.4 Column limit: 80 or 100] + + + link:#s4.5-line-wrapping[4.5 Line-wrapping] + + + link:#s4.5.1-line-wrapping-where-to-break[4.5.1 Where to break] + + + link:#s4.5.2-line-wrapping-indent[4.5.2 Indent continuation lines at least +4 spaces] + + + link:#s4.6-whitespace[4.6 Whitespace] + + + link:#s4.6.1-vertical-whitespace[4.6.1 Vertical Whitespace] + + + link:#s4.6.2-horizontal-whitespace[4.6.2 Horizontal whitespace] + + + link:#s4.6.3-horizontal-alignment[4.6.3 Horizontal alignment: never required] + + + link:#s4.7-grouping-parentheses[4.7 Grouping parentheses: recommended] + + + link:#s4.8-specific-constructs[4.8 Specific constructs] + + + link:#s4.8.1-enum-classes[4.8.1 Enum classes] + + + link:#s4.8.2-variable-declarations[4.8.2 Variable declarations] + + + link:#s4.8.3-arrays[4.8.3 Arrays] + + + link:#s4.8.4-switch[4.8.4 Switch statements] + + + link:#s4.8.5-annotations[4.8.5 Annotations] + + + link:#s4.8.6-comments[4.8.6 Comments] + + + link:#s4.8.7-modifiers[4.8.7 Modifiers] + + + link:#s4.8.8-numeric-literals[4.8.8 Numeric Literals] + + a| + link:#s5-naming[5 Naming] :: + link:#s5.1-identifier-names[5.1 Rules common to all identifiers] + + + link:#s5.2-specific-identifier-names[5.2 Rules by identifier type] + + + link:#s5.2.1-package-names[5.2.1 Package names] + + + link:#s5.2.2-class-names[5.2.2 Class names] + + + link:#s5.2.3-method-names[5.2.3 Method names] + + + link:#s5.2.4-constant-names[5.2.4 Constant names] + + + link:#s5.2.5-non-constant-field-names[5.2.5 Non-constant field names] + + + link:#s5.2.6-parameter-names[5.2.6 Parameter names] + + + link:#s5.2.7-local-variable-names[5.2.7 Local variable names] + + + link:#s5.2.8-type-variable-names[5.2.8 Type variable names] + + + link:#s5.3-camel-case[5.3 Camel case: defined] + link:#s6-programming-practices[6 Programming Practices] :: + link:#s6.1-override-annotation[6.1 @Override: always used] + + + link:#s6.2-caught-exceptions[6.2 Caught exceptions: not ignored] + + + link:#s6.3-static-members[6.3 Static members: qualified using class] + + + link:#s6.4-finalizers[6.4 Finalizers: not used] + link:#s7-javadoc[7 Javadoc] :: + link:#s7.1-javadoc-formatting[7.1 Formatting] + + + link:#s7.1.1-javadoc-multi-line[7.1.1 General form] + + + link:#s7.1.2-javadoc-paragraphs[7.1.2 Paragraphs] + + + link:#s7.1.3-javadoc-at-clauses[7.1.3 At-clauses] + + + link:#s7.2-summary-fragment[7.2 The summary fragment] + + + link:#s7.3-javadoc-where-required[7.3 Where Javadoc is used] + + + link:#s7.3.1-javadoc-exception-self-explanatory[7.3.1 Exception: self-explanatory methods] + + + link:#s7.3.2-javadoc-exception-overrides[7.3.2 Exception: overrides] + +|=========================================================================================== + +[[s1-introduction]] +== 1 Introduction + +This document serves as the *complete* definition of Google's coding standards for source code in the Java™ Programming Language. A Java source file is described as being _in Google Style_ if and only if it adheres to the rules herein. + +Like other programming style guides, the issues covered span not only aesthetic issues of formatting, but other types of conventions or coding standards as well. However, this document focuses primarily on the *hard-and-fast rules* that we follow universally, and avoids giving _advice_ that isn't clearly enforceable (whether by human or tool). + +[[s1.1-terminology]] +=== 1.1 Terminology notes + +In this document, unless otherwise clarified: + +1. The term _class_ is used inclusively to mean an "ordinary" class, enum class, interface or annotation type (`@interface`). +2. The term _comment_ always refers to _implementation_ comments. We do not use the phrase "documentation comments", instead using the common term "Javadoc." + +Other "terminology notes" will appear occasionally throughout the document. + +[[s1.2-guide-notes]] +=== 1.2 Guide notes + +Example code in this document is **non-normative**. That is, while the examples are in Google Style, they may not illustrate the _only_ stylish way to represent the code. Optional formatting choices made in examples should not be enforced as rules. + +[[s2-source-file-basics]] +== 2 Source file basics + +[[s2.1-file-name]] +=== 2.1 File name + +The source file name consists of the case-sensitive name of the top-level class it contains, plus the `.java` extension. + +[[s2.2-file-encoding]] +=== 2.2 File encoding: UTF-8 + +Source files are encoded in **UTF-8**. + +[[s2.3-special-characters]] +=== 2.3 Special characters + +[[s2.3.1-whitespace-characters]] +==== 2.3.1 Whitespace characters + +Aside from the line terminator sequence, the *ASCII horizontal space character* (**0x20**) is the only whitespace character that appears anywhere in a source file. This implies that: + +1. All other whitespace characters in string and character literals are escaped. +2. Tab characters are *not* used for indentation. + +[[s2.3.2-special-escape-sequences]] +==== 2.3.2 Special escape sequences + +For any character that has a special escape sequence (`\b`, `\t`, `\n`, `\f`, `\r`, `\"`, `\'` and `\\`), that sequence is used rather than the corresponding octal (e.g. `\012`) or Unicode (e.g. `\u000a`) escape. + +[[s2.3.3-non-ascii-characters]] +==== 2.3.3 Non-ASCII characters + +For the remaining non-ASCII characters, either the actual Unicode character (e.g. `∞`) or the equivalent Unicode escape (e.g. `\u221e`) is used, depending only on which makes the code **easier to read and understand**. + +*Tip:* In the Unicode escape case, and occasionally even when actual Unicode characters are used, an explanatory comment can be very helpful. + +Examples: + +[cols=",",options="header",] +|================================================================================================================================= +|Example |Discussion +|`String unitAbbrev = "μs";` |Best: perfectly clear even without a comment. +|`String unitAbbrev = "\u03bcs"; // "μs"` |Allowed, but there's no reason to do this. +|`String unitAbbrev = "\u03bcs"; // Greek letter mu, "s"` |Allowed, but awkward and prone to mistakes. +|`String unitAbbrev = "\u03bcs";` |Poor: the reader has no idea what this is. +|`return '\ufeff' + content; // byte order mark` |Good: use escapes for non-printable characters, and comment if necessary. +|================================================================================================================================= + +*Tip:* Never make your code less readable simply out of fear that some programs might not handle non-ASCII characters properly. If that should happen, those programs are *broken* and they must be **fixed**. + +[[s3-source-file-structure]] +== 3 Source file structure + +A source file consists of, **in order**: + +1. License or copyright information, if present +2. Package statement +3. Import statements +4. Exactly one top-level class + +*Exactly one blank line* separates each section that is present. + +[[s3.1-copyright-statement]] +=== 3.1 License or copyright information, if present + +If license or copyright information belongs in a file, it belongs here. + +[[s3.2-package-statement]] +=== 3.2 Package statement + +The package statement is **not line-wrapped**. The column limit (Section 4.4, link:#s4.4-column-limit[Column limit: 80 or 100]) does not apply to package statements. + +[[s3.3-import-statements]] +=== 3.3 Import statements + +[[s3.3.1-wildcard-imports]] +==== 3.3.1 No wildcard imports + +**Wildcard imports**, static or otherwise, **are not used**. + +[[s3.3.2-import-line-wrapping]] +==== 3.3.2 No line-wrapping + +Import statements are **not line-wrapped**. The column limit (Section 4.4, link:#s4.4-column-limit[Column limit: 80 or 100]) does not apply to import statements. + +[[s3.3.3-import-ordering-and-spacing]] +==== 3.3.3 Ordering and spacing + +Import statements are divided into the following groups, in this order, with each group separated by a single blank line: + +1. All static imports in a single group +2. `com.google` imports (only if this source file is in the `com.google` package space) +3. Third-party imports, one group per top-level package, in ASCII sort order +* for example: `android`, `com`, `junit`, `org`, `sun` +4. `java` imports +5. `javax` imports + +Within a group there are no blank lines, and the imported names appear in ASCII sort order. (**Note:** this is not the same as the import _statements_ being in ASCII sort order; the presence of semicolons warps the result.) + +[[s3.4-class-declaration]] +=== 3.4 Class declaration + +[[s3.4.1-one-top-level-class]] +==== 3.4.1 Exactly one top-level class declaration + +Each top-level class resides in a source file of its own. + +[[s3.4.2-class-member-ordering]] +==== 3.4.2 Class member ordering + +The ordering of the members of a class can have a great effect on learnability, but there is no single correct recipe for how to do it. Different classes may order their members differently. + +What is important is that each class order its members in **_some_ logical order**, which its maintainer could explain if asked. For example, new methods are not just habitually added to the end of the class, as that would yield "chronological by date added" ordering, which is not a logical ordering. + +[[s3.4.2.1-overloads-never-split]] +===== 3.4.2.1 Overloads: never split + +When a class has multiple constructors, or multiple methods with the same name, these appear sequentially, with no intervening members. + +[[s4-formatting]] +== 4 Formatting + +*Terminology Note:* _block-like construct_ refers to the body of a class, method or constructor. Note that, by Section 4.8.3.1 on link:#s4.8.3.1-array-initializers[array initializers], any array initializer _may_ optionally be treated as if it were a block-like construct. + +[[s4.1-braces]] +=== 4.1 Braces + +[[s4.1.1-braces-always-used]] +==== 4.1.1 Braces are used where optional + +Braces are used with `if`, `else`, `for`, `do` and `while` statements, even when the body is empty or contains only a single statement. + +[[s4.1.2-blocks-k-r-style]] +==== 4.1.2 Nonempty blocks: K & R style + +Braces follow the Kernighan and Ritchie style ("http://www.codinghorror.com/blog/2012/07/new-programming-jargon.html[Egyptian brackets]") for _nonempty_ blocks and block-like constructs: + +* No line break before the opening brace. +* Line break after the opening brace. +* Line break before the closing brace. +* Line break after the closing brace _if_ that brace terminates a statement or the body of a method, constructor or _named_ class. For example, there is _no_ line break after the brace if it is followed by `else` or a comma. + +Example: + +------------------------------------ +return new MyClass() { + @Override public void method() { + if (condition()) { + try { + something(); + } catch (ProblemException e) { + recover(); + } + } + } +}; +------------------------------------ + +A few exceptions for enum classes are given in Section 4.8.1, link:#s4.8.1-enum-classes[Enum classes]. + +[[s4.1.3-braces-empty-blocks]] +==== 4.1.3 Empty blocks: may be concise + +An empty block or block-like construct _may_ be closed immediately after it is opened, with no characters or line break in between (`{}`), *unless* it is part of a _multi-block statement_ (one that directly contains multiple blocks: `if/else-if/else` or `try/catch/finally`). + +Example: + +--------------------- + void doNothing() {} +--------------------- + +[[s4.2-block-indentation]] +=== 4.2 Block indentation: +2 spaces + +Each time a new block or block-like construct is opened, the indent increases by two spaces. When the block ends, the indent returns to the previous indent level. The indent level applies to both code and comments throughout the block. (See the example in Section 4.1.2, link:#s4.1.2-blocks-k-r-style[Nonempty blocks: K & R Style].) + +[[s4.3-one-statement-per-line]] +=== 4.3 One statement per line + +Each statement is followed by a line-break. + +[[s4.4-column-limit]] +=== 4.4 Column limit: 80 or 100 + +Projects are free to choose a column limit of either 80 or 100 characters. Except as noted below, any line that would exceed this limit must be line-wrapped, as explained in Section 4.5, link:#s4.5-line-wrapping[Line-wrapping]. + +*Exceptions:* + +1. Lines where obeying the column limit is not possible (for example, a long URL in Javadoc, or a long JSNI method reference). +2. `package` and `import` statements (see Sections 3.2 link:#s3.2-package-statement[Package statement] and 3.3 link:#s3.3-import-statements[Import statements]). +3. Command lines in a comment that may be cut-and-pasted into a shell. + +[[s4.5-line-wrapping]] +=== 4.5 Line-wrapping + +*Terminology Note:* When code that might otherwise legally occupy a single line is divided into multiple lines, typically to avoid overflowing the column limit, this activity is called __line-wrapping__. + +There is no comprehensive, deterministic formula showing _exactly_ how to line-wrap in every situation. Very often there are several valid ways to line-wrap the same piece of code. + +*Tip:* Extracting a method or local variable may solve the problem without the need to line-wrap. + +[[s4.5.1-line-wrapping-where-to-break]] +==== 4.5.1 Where to break + +The prime directive of line-wrapping is: prefer to break at a **higher syntactic level**. Also: + +1. When a line is broken at a _non-assignment_ operator the break comes _before_ the symbol. (Note that this is not the same practice used in Google style for other languages, such as C++ and JavaScript.) +* This also applies to the following "operator-like" symbols: the dot separator (`.`), the ampersand in type bounds (``), and the pipe in catch blocks (`catch (FooException | BarException e)`). +2. When a line is broken at an _assignment_ operator the break typically comes _after_ the symbol, but either way is acceptable. +* This also applies to the "assignment-operator-like" colon in an enhanced `for` ("foreach") statement. +3. A method or constructor name stays attached to the open parenthesis (`(`) that follows it. +4. A comma (`,`) stays attached to the token that precedes it. + +[[s4.5.2-line-wrapping-indent]] +==== 4.5.2 Indent continuation lines at least +4 spaces + +When line-wrapping, each line after the first (each __continuation line__) is indented at least +4 from the original line. + +When there are multiple continuation lines, indentation may be varied beyond +4 as desired. In general, two continuation lines use the same indentation level if and only if they begin with syntactically parallel elements. + +Section 4.6.3 on link:#s4.6.3-horizontal-alignment[Horizontal alignment] addresses the discouraged practice of using a variable number of spaces to align certain tokens with previous lines. + +[[s4.6-whitespace]] +=== 4.6 Whitespace + +[[s4.6.1-vertical-whitespace]] +==== 4.6.1 Vertical Whitespace + +A single blank line appears: + +1. _Between_ consecutive members (or initializers) of a class: fields, constructors, methods, nested classes, static initializers, instance initializers. +* *Exception:* A blank line between two consecutive fields (having no other code between them) is optional. Such blank lines are used as needed to create _logical groupings_ of fields. +2. Within method bodies, as needed to create _logical groupings_ of statements. +3. _Optionally_ before the first member or after the last member of the class (neither encouraged nor discouraged). +4. As required by other sections of this document (such as Section 3.3, link:#s3.3-import-statements[Import statements]). + +_Multiple_ consecutive blank lines are permitted, but never required (or encouraged). + +[[s4.6.2-horizontal-whitespace]] +==== 4.6.2 Horizontal whitespace + +Beyond where required by the language or other style rules, and apart from literals, comments and Javadoc, a single ASCII space also appears in the following places **only**. + +1. Separating any reserved word, such as `if`, `for` or `catch`, from an open parenthesis (`(`) that follows it on that line +2. Separating any reserved word, such as `else` or `catch`, from a closing curly brace (`}`) that precedes it on that line +3. Before any open curly brace (`{`), with two exceptions: +* `@SomeAnnotation({a, b})` (no space is used) +* `String[][] x = {{"foo"}};` (no space is required between `{{`, by item 8 below) +4. On both sides of any binary or ternary operator. This also applies to the following "operator-like" symbols: +* the ampersand in a conjunctive type bound: `` +* the pipe for a catch block that handles multiple exceptions: `catch (FooException | BarException e)` +* the colon (`:`) in an enhanced `for` ("foreach") statement +5. After `,:;` or the closing parenthesis (`)`) of a cast +6. On both sides of the double slash (`//`) that begins an end-of-line comment. Here, multiple spaces are allowed, but not required. +7. Between the type and variable of a declaration: `List list` +8. _Optional_ just inside both braces of an array initializer +* `new int[] {5, 6}` and `new int[] { 5, 6 }` are both valid + +*Note:* This rule never requires or forbids additional space at the start or end of a line, only _interior_ space. + +[[s4.6.3-horizontal-alignment]] +==== 4.6.3 Horizontal alignment: never required + +*Terminology Note:* _Horizontal alignment_ is the practice of adding a variable number of additional spaces in your code with the goal of making certain tokens appear directly below certain other tokens on previous lines. + +This practice is permitted, but is *never required* by Google Style. It is not even required to _maintain_ horizontal alignment in places where it was already used. + +Here is an example without alignment, then using alignment: + +---------------------------------------------------- +private int x; // this is fine +private Color color; // this too + +private int x; // permitted, but future edits +private Color color; // may leave it unaligned +---------------------------------------------------- + +*Tip:* Alignment can aid readability, but it creates problems for future maintenance. Consider a future change that needs to touch just one line. This change may leave the formerly-pleasing formatting mangled, and that is **allowed**. More often it prompts the coder (perhaps you) to adjust whitespace on nearby lines as well, possibly triggering a cascading series of reformattings. That one-line change now has a "blast radius." This can at worst result in pointless busywork, but at best it still corrupts version history information, slows down reviewers and exacerbates merge conflicts. + +[[s4.7-grouping-parentheses]] +=== 4.7 Grouping parentheses: recommended + +Optional grouping parentheses are omitted only when author and reviewer agree that there is no reasonable chance the code will be misinterpreted without them, nor would they have made the code easier to read. It is _not_ reasonable to assume that every reader has the entire Java operator precedence table memorized. + +[[s4.8-specific-constructs]] +=== 4.8 Specific constructs + +[[s4.8.1-enum-classes]] +==== 4.8.1 Enum classes + +After each comma that follows an enum constant, a line-break is optional. + +An enum class with no methods and no documentation on its constants may optionally be formatted as if it were an array initializer (see Section 4.8.3.1 on link:#s4.8.3.1-array-initializers[array initializers]). + +----------------------------------------------------- +private enum Suit { CLUBS, HEARTS, SPADES, DIAMONDS } +----------------------------------------------------- + +Since enum classes __are classes__, all other rules for formatting classes apply. + +[[s4.8.2-variable-declarations]] +==== 4.8.2 Variable declarations + +[[s4.8.2.1-variables-per-declaration]] +===== 4.8.2.1 One variable per declaration + +Every variable declaration (field or local) declares only one variable: declarations such as `int a, b;` are not used. + +[[s4.8.2.2-variables-limited-scope]] +===== 4.8.2.2 Declared when needed, initialized as soon as possible + +Local variables are *not* habitually declared at the start of their containing block or block-like construct. Instead, local variables are declared close to the point they are first used (within reason), to minimize their scope. Local variable declarations typically have initializers, or are initialized immediately after declaration. + +[[s4.8.3-arrays]] +==== 4.8.3 Arrays + +[[s4.8.3.1-array-initializers]] +===== 4.8.3.1 Array initializers: can be "block-like" + +Any array initializer may _optionally_ be formatted as if it were a "block-like construct." For example, the following are all valid (**not** an exhaustive list): + +-------------------------------------- +new int[] { new int[] { + 0, 1, 2, 3 0, +} 1, + 2, +new int[] { 3, + 0, 1, } + 2, 3 +} new int[] + {0, 1, 2, 3} +-------------------------------------- + +[[s4.8.3.2-array-declarations]] +===== 4.8.3.2 No C-style array declarations + +The square brackets form a part of the __type__, not the variable: `String[] args`, not `String args[]`. + +[[s4.8.4-switch]] +==== 4.8.4 Switch statements + +*Terminology Note:* Inside the braces of a _switch block_ are one or more __statement groups__. Each statement group consists of one or more _switch labels_ (either `case FOO:` or `default:`), followed by one or more statements. + +[[s4.8.4.1-switch-indentation]] +===== 4.8.4.1 Indentation + +As with any other block, the contents of a switch block are indented +2. + +After a switch label, a newline appears, and the indentation level is increased +2, exactly as if a block were being opened. The following switch label returns to the previous indentation level, as if a block had been closed. + +[[s4.8.4.2-switch-fall-through]] +===== 4.8.4.2 Fall-through: commented + +Within a switch block, each statement group either terminates abruptly (with a `break`, `continue`, `return` or thrown exception), or is marked with a comment to indicate that execution will or _might_ continue into the next statement group. Any comment that communicates the idea of fall-through is sufficient (typically `// fall through`). This special comment is not required in the last statement group of the switch block. Example: + +----------------------------- +switch (input) { + case 1: + case 2: + prepareOneOrTwo(); + // fall through + case 3: + handleOneTwoOrThree(); + break; + default: + handleLargeNumber(input); +} +----------------------------- + +[[s4.8.4.3-switch-default]] +===== 4.8.4.3 The default case is present + +Each switch statement includes a `default` statement group, even if it contains no code. + +[[s4.8.5-annotations]] +==== 4.8.5 Annotations + +Annotations applying to a class, method or constructor appear immediately after the documentation block, and each annotation is listed on a line of its own (that is, one annotation per line). These line breaks do not constitute line-wrapping (Section 4.5, link:#s4.5-line-wrapping[Line-wrapping]), so the indentation level is not increased. Example: + +---------------------------------------- +@Override +@Nullable +public String getNameIfPresent() { ... } +---------------------------------------- + +*Exception:* A _single_ parameterless annotation _may_ instead appear together with the first line of the signature, for example: + +--------------------------------------- +@Override public int hashCode() { ... } +--------------------------------------- + +Annotations applying to a field also appear immediately after the documentation block, but in this case, _multiple_ annotations (possibly parameterized) may be listed on the same line; for example: + +--------------------------------- +@Partial @Mock DataLoader loader; +--------------------------------- + +There are no specific rules for formatting parameter and local variable annotations. + +[[s4.8.6-comments]] +==== 4.8.6 Comments + +[[s4.8.6.1-block-comment-style]] +===== 4.8.6.1 Block comment style + +Block comments are indented at the same level as the surrounding code. They may be in `/* ... */` style or `// ...` style. For multi-line `/* ... */` comments, subsequent lines must start with `*` aligned with the `*` on the previous line. + +----------------------------------------------------------- +/* + * This is // And so /* Or you can + * okay. // is this. * even do this. */ + */ +----------------------------------------------------------- + +Comments are not enclosed in boxes drawn with asterisks or other characters. + +*Tip:* When writing multi-line comments, use the `/* ... */` style if you want automatic code formatters to re-wrap the lines when necessary (paragraph-style). Most formatters don't re-wrap lines in `// ...` style comment blocks. + +[[s4.8.7-modifiers]] +==== 4.8.7 Modifiers + +Class and member modifiers, when present, appear in the order recommended by the Java Language Specification: + +---------------------------------------------------------------------------------------------- +public protected private abstract static final transient volatile synchronized native strictfp +---------------------------------------------------------------------------------------------- + +[[s4.8.8-numeric-literals]] +==== 4.8.8 Numeric Literals + +`long`-valued integer literals use an uppercase `L` suffix, never lowercase (to avoid confusion with the digit `1`). For example, `3000000000L` rather than `3000000000l`. + +[[s5-naming]] +== 5 Naming + +[[s5.1-identifier-names]] +=== 5.1 Rules common to all identifiers + +Identifiers use only ASCII letters and digits, and in two cases noted below, underscores. Thus each valid identifier name is matched by the regular expression `\w+` . + +In Google Style special prefixes or suffixes, like those seen in the examples `name_`, `mName`, `s_name` and `kName`, are *not* used. + +[[s5.2-specific-identifier-names]] +=== 5.2 Rules by identifier type + +[[s5.2.1-package-names]] +==== 5.2.1 Package names + +Package names are all lowercase, with consecutive words simply concatenated together (no underscores). For example, `com.example.deepspace`, not `com.example.deepSpace` or `com.example.deep_space`. + +[[s5.2.2-class-names]] +==== 5.2.2 Class names + +Class names are written in link:#s5.3-camel-case[UpperCamelCase]. + +Class names are typically nouns or noun phrases. For example, `Character` or `ImmutableList`. Interface names may also be nouns or noun phrases (for example, `List`), but may sometimes be adjectives or adjective phrases instead (for example, `Readable`). + +There are no specific rules or even well-established conventions for naming annotation types. + +_Test_ classes are named starting with the name of the class they are testing, and ending with `Test`. For example, `HashTest` or `HashIntegrationTest`. + +[[s5.2.3-method-names]] +==== 5.2.3 Method names + +Method names are written in link:#s5.3-camel-case[lowerCamelCase]. + +Method names are typically verbs or verb phrases. For example, `sendMessage` or `stop`. + +Underscores may appear in JUnit _test_ method names to separate logical components of the name. One typical pattern is `test_`, for example `testPop_emptyStack`. There is no One Correct Way to name test methods. + +[[s5.2.4-constant-names]] +==== 5.2.4 Constant names + +Constant names use `CONSTANT_CASE`: all uppercase letters, with words separated by underscores. But what _is_ a constant, exactly? + +Every constant is a static final field, but not all static final fields are constants. Before choosing constant case, consider whether the field really _feels like_ a constant. For example, if any of that instance's observable state can change, it is almost certainly not a constant. Merely _intending_ to never mutate the object is generally not enough. Examples: + +-------------------------------------------------------------------------------------- +// Constants +static final int NUMBER = 5; +static final ImmutableList NAMES = ImmutableList.of("Ed", "Ann"); +static final Joiner COMMA_JOINER = Joiner.on(','); // because Joiner is immutable +static final SomeMutableType[] EMPTY_ARRAY = {}; +enum SomeEnum { ENUM_CONSTANT } + +// Not constants +static String nonFinal = "non-final"; +final String nonStatic = "non-static"; +static final Set mutableCollection = new HashSet(); +static final ImmutableSet mutableElements = ImmutableSet.of(mutable); +static final Logger logger = Logger.getLogger(MyClass.getName()); +static final String[] nonEmptyArray = {"these", "can", "change"}; +-------------------------------------------------------------------------------------- + +These names are typically nouns or noun phrases. + +[[s5.2.5-non-constant-field-names]] +==== 5.2.5 Non-constant field names + +Non-constant field names (static or otherwise) are written in link:#s5.3-camel-case[lowerCamelCase]. + +These names are typically nouns or noun phrases. For example, `computedValues` or `index`. + +[[s5.2.6-parameter-names]] +==== 5.2.6 Parameter names + +Parameter names are written in link:#s5.3-camel-case[lowerCamelCase]. + +One-character parameter names should be avoided. + +[[s5.2.7-local-variable-names]] +==== 5.2.7 Local variable names + +Local variable names are written in link:#s5.3-camel-case[lowerCamelCase], and can be abbreviated more liberally than other types of names. + +However, one-character names should be avoided, except for temporary and looping variables. + +Even when final and immutable, local variables are not considered to be constants, and should not be styled as constants. + +[[s5.2.8-type-variable-names]] +==== 5.2.8 Type variable names + +Each type variable is named in one of two styles: + +* A single capital letter, optionally followed by a single numeral (such as `E`, `T`, `X`, `T2`) +* A name in the form used for classes (see Section 5.2.2, link:#s5.2.2-class-names[Class names]), followed by the capital letter `T` (examples: `RequestT`, `FooBarT`). + +[[s5.3-camel-case]] +=== 5.3 Camel case: defined + +Sometimes there is more than one reasonable way to convert an English phrase into camel case, such as when acronyms or unusual constructs like "IPv6" or "iOS" are present. To improve predictability, Google Style specifies the following (nearly) deterministic scheme. + +Beginning with the prose form of the name: + +1. Convert the phrase to plain ASCII and remove any apostrophes. For example, "Müller's algorithm" might become "Muellers algorithm". +2. Divide this result into words, splitting on spaces and any remaining punctuation (typically hyphens). +* _Recommended:_ if any word already has a conventional camel-case appearance in common usage, split this into its constituent parts (e.g., "AdWords" becomes "ad words"). Note that a word such as "iOS" is not really in camel case __per se__; it defies _any_ convention, so this recommendation does not apply. +3. Now lowercase _everything_ (including acronyms), then uppercase only the first character of: +* ... each word, to yield __upper camel case__, or +* ... each word except the first, to yield _lower camel case_ +4. Finally, join all the words into a single identifier. + +Note that the casing of the original words is almost entirely disregarded. Examples: + +[width="100%",cols="34%,33%,33%",options="header",] +|================================================================= +|Prose form |Correct |Incorrect +|"XML HTTP request" |`XmlHttpRequest` |`XMLHTTPRequest` +|"new customer ID" |`newCustomerId` |`newCustomerID` +|"inner stopwatch" |`innerStopwatch` |`innerStopWatch` +|"supports IPv6 on iOS?" |`supportsIpv6OnIos` |`supportsIPv6OnIOS` +|"YouTube importer" |`YouTubeImporter` + +`YoutubeImporter`* | +|================================================================= + +*Acceptable, but not recommended. + +*Note:* Some words are ambiguously hyphenated in the English language: for example "nonempty" and "non-empty" are both correct, so the method names `checkNonempty` and `checkNonEmpty` are likewise both correct. + +[[s6-programming-practices]] +== 6 Programming Practices + +[[s6.1-override-annotation]] +=== 6.1 @Override: always used + +A method is marked with the `@Override` annotation whenever it is legal. This includes a class method overriding a superclass method, a class method implementing an interface method, and an interface method respecifying a superinterface method. + +**Exception:**`@Override` may be omitted when the parent method is `@Deprecated`. + +[[s6.2-caught-exceptions]] +=== 6.2 Caught exceptions: not ignored + +Except as noted below, it is very rarely correct to do nothing in response to a caught exception. (Typical responses are to log it, or if it is considered "impossible", rethrow it as an `AssertionError`.) + +When it truly is appropriate to take no action whatsoever in a catch block, the reason this is justified is explained in a comment. + +------------------------------------------------- +try { + int i = Integer.parseInt(response); + return handleNumericResponse(i); +} catch (NumberFormatException ok) { + // it's not numeric; that's fine, just continue +} +return handleTextResponse(response); +------------------------------------------------- + +*Exception:* In tests, a caught exception may be ignored without comment _if_ it is named `expected`. The following is a very common idiom for ensuring that the method under test _does_ throw an exception of the expected type, so a comment is unnecessary here. + +------------------------------------------- +try { + emptyStack.pop(); + fail(); +} catch (NoSuchElementException expected) { +} +------------------------------------------- + +[[s6.3-static-members]] +=== 6.3 Static members: qualified using class + +When a reference to a static class member must be qualified, it is qualified with that class's name, not with a reference or expression of that class's type. + +------------------------------------------------------ +Foo aFoo = ...; +Foo.aStaticMethod(); // good +aFoo.aStaticMethod(); // bad +somethingThatYieldsAFoo().aStaticMethod(); // very bad +------------------------------------------------------ + +[[s6.4-finalizers]] +=== 6.4 Finalizers: not used + +It is *extremely rare* to override `Object.finalize`. + +*Tip:* Don't do it. If you absolutely must, first read and understand http://books.google.com/books?isbn=8131726592[_Effective Java_] Item 7, "Avoid Finalizers," very carefully, and _then_ don't do it. + +[[s7-javadoc]] +== 7 Javadoc + +[[s7.1-javadoc-formatting]] +=== 7.1 Formatting + +[[s7.1.1-javadoc-multi-line]] +==== 7.1.1 General form + +The _basic_ formatting of Javadoc blocks is as seen in this example: + +--------------------------------------------------- +/** + * Multiple lines of Javadoc text are written here, + * wrapped normally... + */ +public int method(String p1) { ... } +--------------------------------------------------- + +... or in this single-line example: + +------------------------------------------ +/** An especially short bit of Javadoc. */ +------------------------------------------ + +The basic form is always acceptable. The single-line form may be substituted when there are no at-clauses present, and the entirety of the Javadoc block (including comment markers) can fit on a single line. + +[[s7.1.2-javadoc-paragraphs]] +==== 7.1.2 Paragraphs + +One blank line—that is, a line containing only the aligned leading asterisk (`*`)—appears between paragraphs, and before the group of "at-clauses" if present. Each paragraph but the first has `

` immediately before the first word, with no space after. + +[[s7.1.3-javadoc-at-clauses]] +==== 7.1.3 At-clauses + +Any of the standard "at-clauses" that are used appear in the order `@param`, `@return`, `@throws`, `@deprecated`, and these four types never appear with an empty description. When an at-clause doesn't fit on a single line, continuation lines are indented four (or more) spaces from the position of the `@`. + +[[s7.2-summary-fragment]] +=== 7.2 The summary fragment + +The Javadoc for each class and member begins with a brief **summary fragment**. This fragment is very important: it is the only part of the text that appears in certain contexts such as class and method indexes. + +This is a fragment—a noun phrase or verb phrase, not a complete sentence. It does *not* begin with `A {@code Foo} is a...`, or `This method returns...`, nor does it form a complete imperative sentence like `Save the record.`. However, the fragment is capitalized and punctuated as if it were a complete sentence. + +*Tip:* A common mistake is to write simple Javadoc in the form `/** @return the customer ID */`. This is incorrect, and should be changed to `/** Returns the customer ID. */`. + +[[s7.3-javadoc-where-required]] +=== 7.3 Where Javadoc is used + +At the __minimum__, Javadoc is present for every `public` class, and every `public` or `protected` member of such a class, with a few exceptions noted below. + +Other classes and members still have Javadoc __as needed__. Whenever an implementation comment would be used to define the overall purpose or behavior of a class, method or field, that comment is written as Javadoc instead. (It's more uniform, and more tool-friendly.) + +[[s7.3.1-javadoc-exception-self-explanatory]] +==== 7.3.1 Exception: self-explanatory methods + +Javadoc is optional for "simple, obvious" methods like `getFoo`, in cases where there _really and truly_ is nothing else worthwhile to say but "Returns the foo". + +*Important:* it is not appropriate to cite this exception to justify omitting relevant information that a typical reader might need to know. For example, for a method named `getCanonicalName`, don't omit its documentation (with the rationale that it would say only `/** Returns the canonical name. */`) if a typical reader may have no idea what the term "canonical name" means! + +[[s7.3.2-javadoc-exception-overrides]] +==== 7.3.2 Exception: overrides + +Javadoc is not always present on a method that overrides a supertype method. + +''''' + +Last changed: March 21, 2014 diff --git a/javaguide.css b/javaguide.css deleted file mode 100644 index c42ba83..0000000 --- a/javaguide.css +++ /dev/null @@ -1,515 +0,0 @@ -table { - border-collapse: collapse; -} - -td, th { - border: 1px solid #ccc; - padding: 2px 12px; - font-size: 10pt; -} - -code, samp, var { - color: #060; -} - -pre { - font-size: 10pt; - display: block; - color: #060; - background-color: #e8fff6; - border-color: #f0fff0; - border-style: solid; - border-top-width: 1px; - border-bottom-width: 1px; - border-right-width: 1px; - border-left-width: 5px; - padding-left: 12px; - padding-right: 12px; - padding-top: 4px; - padding-bottom: 4px; -} - -pre.badcode { - color: #c00; - background-color: #ffe6d8; - border-color: #fff0f0; -} - -hr { - margin-top: 3.5em; - border-width: 1px; - color: #fff; -} - -html { - margin-top:2em; - margin-left:10%; - margin-right:10%; - padding:0; -} - -.bp-reset-element, -body, -h1, -h2, -h3, -h4, -h5, -h6, -article, -aside, -details, -figcaption, -figure, -footer, -header, -hgroup, -menu, -nav, -section, -summary, -blockquote, -q, -th, -td, -caption, -table, -div, -span, -object, -iframe, -p, -pre, -a, -abbr, -acronym, -address, -code, -del, -dfn, -em, -img, -dl, -dt, -dd, -ol, -ul, -li, -fieldset, -form, -label, -legend, -caption, -tbody, -tfoot, -thead, -tr { - margin:0; - padding:0; - border:0; - font-weight:inherit; - font-style:inherit; - font-size:100%; - font-family:inherit; - vertical-align:baseline; -} - -body { - font-family:'Arial', sans-serif; - font-size:81.25%; - color:#222; - background-color:#fff; - line-height:1.67; - overflow: auto; -} - -.change { - text-align: right; - margin-bottom:1em; -} - -em { - font-style: italic -} - -h1, -h2, -h3, -h4, -h5, -h6 { - font-weight:bold; -} - -h1 { - margin-bottom:.50em; - text-align: center -} - -h2, -h3, -h4, -h5, -h6 { - margin-top:1.5em; - margin-bottom:.75em; -} - -h1 {font-size:200%;} -h2 {font-size:167%;} -h3 {font-size:133%;} -h4 {font-size:120%;} -h5 {font-size:110%;} - -p { - margin:0 0 1.5em; -} - -a[href=''] { - cursor:default; -} - -h1 img, -h2 img, -h3 img, -h4 img, -h5 img, -h6 img { - margin:0; -} - -a img { - border:none; -} - -pre { - margin:1.5em 0; - white-space:pre; -} - -pre, -code, -kbd, -tt { - font:1em 'Droid Sans Mono', monospace; - line-height:1.5; -} - -dl { - margin:0 0 1.5em 0; -} - -dl dt { - font-weight:bold; -} - -dd { - margin-left:1.5em; -} - -dd.toc3 { - margin-left:3em; -} - -hr { - height:0; - border:0; - border-top:1px solid #ccc; - background-color:#ccc; -} - -table { - border:1px solid #bbb; - border-spacing:0; - border-collapse:collapse; - margin:0 0 1.5em; - vertical-align:middle; - width:100%; -} - -table.unlined, -table.unlined th, -table.unlined tr, -table.unlined td { - border:0; -} - -th, -td, -caption { - float:none !important; - text-align:left; - font-weight:normal; - vertical-align:middle; - padding:4px; -} - -caption { - padding:0; -} - -td { - border:1px solid #bbb; - vertical-align:top; -} - -th { - border:0; - border-bottom:1px solid black; - font-weight:bold; - background:rgb(229, 236, 249); -} - -table th code { - background-color:inherit; - color:inherit; -} - -table tfoot th { - border:1px solid #bbb; -} - -tfoot { - font-style:italic; -} - -caption { - background:#eee; -} - -table[border='0'] { - border:none; -} - -table[border='0']>tbody>tr>td, -table[border='0']>tr>td { - border:none; -} - -tr.alt td, -td.alt { - background-color:#efefef; -} - -table.striped tr:nth-child(even) td, -table tr.even td { - background:#efefef; -} - -table.columns { - border:none; -} - -table.columns>tbody>tr>td, -table.columns>tr>td { - border:none; - padding:0 3em 0 0; -} - -table.columns>tbody>tr>td:last-child, -table.columns>tr>td:last-child { - border:none; - padding:0; -} - -ul, -ol { - margin:0 1.5em 1.5em 0; - padding-left:2em; -} - -li ul, -li ol { - margin:0; -} - -ul { - list-style-type:disc; -} - -ol { - list-style-type:decimal; -} - -ul { - list-style-type:disc; -} - -ul ul { - list-style-type:circle; -} - -ul ul ul { - list-style-type:square; -} - -ul.disc { - list-style-type:disc; -} - -ul.circle { - list-style-type:circle; -} - -ul.square { - list-style-type:square; -} - -ol { - list-style-type:decimal; -} - -ol ol { - list-style-type:lower-alpha; -} - -ol ol ol { - list-style-type:lower-roman; -} - -ol ul { - list-style-type:circle; -} - -ol.decimal { - list-style-type:decimal; -} - -ol.upper-alpha { - list-style-type:upper-alpha; -} - -ol.lower-alpha { - list-style-type:lower-alpha; -} - -ol.upper-roman { - list-style-type:upper-roman; -} - -ol.lower-roman { - list-style-type:lower-roman; -} - -ol.nolist, -ul.nolist { - padding-left:0; - list-style-image:none; - list-style-type:none; - margin-left:0; -} - -.center { - text-align:center; -} - -code, -kbd, -pre { - color:#009900; -} - -kbd { - font-weight: bold; -} - -table.striped code { - background-color:inherit; -} - -pre { - padding:6px 10px; - background-color:#FAFAFA; - border:1px solid #bbb; - overflow:auto; -} - -pre.prettyprint { - padding:6px 10px !important; - border:1px solid #bbb !important; -} - -code.bad, code.badcode { - color: magenta; -} -pre.bad, pre.badcode { - background-color:#ffe6d8; - border-top:1px inset #a03; - border-left:1px inset #a03; -} - -.tip { - background-color:#fffbd9; - padding:6px 8px 6px 10px; - border-left:6px solid #ffef70; -} - -.note { - background-color:#e5ecf9; - padding:6px 8px 6px 10px; - border-left:6px solid #36c; -} - -@media print { - - .str { - color:#060; - } - - .kwd { - color:#006; - font-weight:bold; - } - - .com { - color:#600; - font-style:italic; - } - - .typ { - color:#404; - font-weight:bold; - } - - .lit { - color:#044; - } - - .pun, - .opn, - .clo { - color:#440; - } - - .pln { - color:#000; - } - - .tag { - color:#006; - font-weight:bold; - } - - .atn { - color:#404; - } - - .atv { - color:#060; - } - - h1 { - font-style:italic; - } -} - -ol.linenums { - margin-top:0; - margin-bottom:0; -} - -code { - background-color:#FAFAFA; - padding: 0.25em 0.5em; - white-space: nowrap -} diff --git a/javaguide.html b/javaguide.html deleted file mode 100644 index 74bfbad..0000000 --- a/javaguide.html +++ /dev/null @@ -1,793 +0,0 @@ - - - - - - - Google Java Style - - -

Google Java Style

-
Last changed: March 21, 2014
- - - - -
-
-
-
-1 Introduction -
-
-1.1 Terminology notes -
-
-1.2 Guide notes -
-
-
-2 Source file basics -
-
-2.1 File name -
-
-2.2 File encoding: UTF-8 -
-
-2.3 Special characters -
-
-2.3.1 Whitespace characters -
-
-2.3.2 Special escape sequences -
-
-2.3.3 Non-ASCII characters -
-
-
-3 Source file structure -
-
-3.1 License or copyright information, if present -
-
-3.2 Package statement -
-
-3.3 Import statements -
-
-3.3.1 No wildcard imports -
-
-3.3.2 No line-wrapping -
-
-3.3.3 Ordering and spacing -
-
-3.4 Class declaration -
-
-3.4.1 Exactly one top-level class declaration -
-
-3.4.2 Class member ordering -
-
-		 -
-
-
-4 Formatting -
-
-4.1 Braces -
-
-4.1.1 Braces are used where optional -
-
-4.1.2 Nonempty blocks: K & R style -
-
-4.1.3 Empty blocks: may be concise -
-
-4.2 Block indentation: +2 spaces -
-
-4.3 One statement per line -
-
-4.4 Column limit: 80 or 100 -
-
-4.5 Line-wrapping -
-
-4.5.1 Where to break -
-
-4.5.2 Indent continuation lines at least +4 spaces -
-
-4.6 Whitespace -
-
-4.6.1 Vertical Whitespace -
-
-4.6.2 Horizontal whitespace -
-
-4.6.3 Horizontal alignment: never required -
-
-4.7 Grouping parentheses: recommended -
-
-4.8 Specific constructs -
-
-4.8.1 Enum classes -
-
-4.8.2 Variable declarations -
-
-4.8.3 Arrays -
-
-4.8.4 Switch statements -
-
-4.8.5 Annotations -
-
-4.8.6 Comments -
-
-4.8.7 Modifiers -
-
-4.8.8 Numeric Literals -
-
-		 -
-
-
-5 Naming -
-
-5.1 Rules common to all identifiers -
-
-5.2 Rules by identifier type -
-
-5.2.1 Package names -
-
-5.2.2 Class names -
-
-5.2.3 Method names -
-
-5.2.4 Constant names -
-
-5.2.5 Non-constant field names -
-
-5.2.6 Parameter names -
-
-5.2.7 Local variable names -
-
-5.2.8 Type variable names -
-
-5.3 Camel case: defined -
-
-
-6 Programming Practices -
-
-6.1 @Override: always used -
-
-6.2 Caught exceptions: not ignored -
-
-6.3 Static members: qualified using class -
-
-6.4 Finalizers: not used -
-
-
-7 Javadoc -
-
-7.1 Formatting -
-
-7.1.1 General form -
-
-7.1.2 Paragraphs -
-
-7.1.3 At-clauses -
-
-7.2 The summary fragment -
-
-7.3 Where Javadoc is used -
-
-7.3.1 Exception: self-explanatory methods -
-
-7.3.2 Exception: overrides -
-
-
-
-

1 Introduction 

-

This document serves as the complete definition of Google's coding standards for -source code in the Java™ Programming Language. A Java source file is described as being in -Google Style if and only if it adheres to the rules herein.

Like other programming style guides, the issues covered span not only aesthetic issues of -formatting, but other types of conventions or coding standards as well. However, this document -focuses primarily on the hard-and-fast rules that we follow universally, and -avoids giving advice that isn't clearly enforceable (whether by human or tool). -

-

1.1 Terminology notes 

-

In this document, unless otherwise clarified:

  1. The term class is used inclusively to mean an "ordinary" class, enum class, - interface or annotation type (@interface).
  2. The term comment always refers to implementation comments. We do not - use the phrase "documentation comments", instead using the common term "Javadoc."

Other "terminology notes" will appear occasionally throughout the document.

-

1.2 Guide notes 

-

Example code in this document is non-normative. That is, while the examples -are in Google Style, they may not illustrate the only stylish way to represent the -code. Optional formatting choices made in examples should not be enforced as rules.

-

2 Source file basics 

- -

2.1 File name 

-

The source file name consists of the case-sensitive name of the top-level class it contains, -plus the .java extension.

-

2.2 File encoding: UTF-8 

-

Source files are encoded in UTF-8.

-

2.3 Special characters 

- -

2.3.1 Whitespace characters 

-

Aside from the line terminator sequence, the ASCII horizontal space -character (0x20) is the only whitespace character that appears -anywhere in a source file. This implies that:

  1. All other whitespace characters in string and character literals are escaped.
  2. Tab characters are not used for indentation.
-

2.3.2 Special escape sequences 

-

For any character that has a special escape sequence -(\b, -\t, -\n, -\f, -\r, -\", -\' and -\\), that sequence -is used rather than the corresponding octal -(e.g. \012) or Unicode -(e.g. \u000a) escape.

-

2.3.3 Non-ASCII characters 

-

For the remaining non-ASCII characters, either the actual Unicode character -(e.g. ∞) or the equivalent Unicode escape -(e.g. \u221e) is used, depending only on which -makes the code easier to read and understand.

Tip: In the Unicode escape case, and occasionally even when actual -Unicode characters are used, an explanatory comment can be very helpful.

Examples:

ExampleDiscussion
String unitAbbrev = "μs";Best: perfectly clear even without a comment.
String unitAbbrev = "\u03bcs"; // "μs"Allowed, but there's no reason to do this.
String unitAbbrev = "\u03bcs"; - // Greek letter mu, "s"Allowed, but awkward and prone to mistakes.
String unitAbbrev = "\u03bcs";Poor: the reader has no idea what this is.
return '\ufeff' + content; - // byte order markGood: use escapes for non-printable characters, and comment if necessary.

Tip: Never make your code less readable simply out of fear that -some programs might not handle non-ASCII characters properly. If that should happen, those -programs are broken and they must be fixed.

-

3 Source file structure 

-

A source file consists of, in order:

  1. License or copyright information, if present
  2. Package statement
  3. Import statements
  4. Exactly one top-level class

Exactly one blank line separates each section that is present.

-

3.1 License or copyright information, if present 

-

If license or copyright information belongs in a file, it belongs here.

-

3.2 Package statement 

-

The package statement is not line-wrapped. The column limit (Section 4.4, -Column limit: 80 or 100) does not apply to package statements.

-

3.3 Import statements 

- -

3.3.1 No wildcard imports 

-

Wildcard imports, static or otherwise, are not used.

-

3.3.2 No line-wrapping 

-

Import statements are not line-wrapped. The column limit (Section 4.4, -Column limit: 80 or 100) does not apply to import -statements.

-

3.3.3 Ordering and spacing 

-

Import statements are divided into the following groups, in this order, with each group -separated by a single blank line:

  1. All static imports in a single group
  2. com.google imports - (only if this source file is in the com.google package - space)
  3. Third-party imports, one group per top-level package, in ASCII sort order -
    • for example: android, com, junit, org, - sun
  4. java imports
  5. javax imports

Within a group there are no blank lines, and the imported names appear in ASCII sort -order. (Note: this is not the same as the import statements being in -ASCII sort order; the presence of semicolons warps the result.)

-

3.4 Class declaration 

- -

3.4.1 Exactly one top-level class declaration 

-

Each top-level class resides in a source file of its own.

-

3.4.2 Class member ordering 

-

The ordering of the members of a class can have a great effect on learnability, but there is -no single correct recipe for how to do it. Different classes may order their members -differently.

What is important is that each class order its members in some logical -order, which its maintainer could explain if asked. For example, new methods are not -just habitually added to the end of the class, as that would yield "chronological by date -added" ordering, which is not a logical ordering.

-
3.4.2.1 Overloads: never split 
-

When a class has multiple constructors, or multiple methods with the same name, these appear -sequentially, with no intervening members.

-

4 Formatting 

-

Terminology Note: block-like construct refers to -the body of a class, method or constructor. Note that, by Section 4.8.3.1 on -array initializers, any array initializer -may optionally be treated as if it were a block-like construct.

-

4.1 Braces 

- -

4.1.1 Braces are used where optional 

-

Braces are used with -if, -else, -for, -do and -while statements, even when the -body is empty or contains only a single statement.

-

4.1.2 Nonempty blocks: K & R style 

-

Braces follow the Kernighan and Ritchie style -("Egyptian brackets") -for nonempty blocks and block-like constructs:

  • No line break before the opening brace.
  • Line break after the opening brace.
  • Line break before the closing brace.
  • Line break after the closing brace if that brace terminates a statement or the body - of a method, constructor or named class. For example, there is no line break - after the brace if it is followed by else or a - comma.

Example:

-return new MyClass() {
-  @Override public void method() {
-    if (condition()) {
-      try {
-        something();
-      } catch (ProblemException e) {
-        recover();
-      }
-    }
-  }
-};
-

A few exceptions for enum classes are given in Section 4.8.1, -Enum classes.

-

4.1.3 Empty blocks: may be concise 

-

An empty block or block-like construct may be closed immediately after it is -opened, with no characters or line break in between -({}), unless it is part of a -multi-block statement (one that directly contains multiple blocks: -if/else-if/else or -try/catch/finally).

Example:

-  void doNothing() {}
-
-

4.2 Block indentation: +2 spaces 

-

Each time a new block or block-like construct is opened, the indent increases by two -spaces. When the block ends, the indent returns to the previous indent level. The indent level -applies to both code and comments throughout the block. (See the example in Section 4.1.2, -Nonempty blocks: K & R Style.)

-

4.3 One statement per line 

-

Each statement is followed by a line-break.

-

4.4 Column limit: 80 or 100 

-

- Projects are free to choose a column limit of either 80 or 100 characters. - -Except as noted below, any line that would exceed this limit must be line-wrapped, as explained in -Section 4.5, Line-wrapping. -

Exceptions:

  1. Lines where obeying the column limit is not possible (for example, a long URL in Javadoc, - or a long JSNI method reference).
  2. package and - import statements (see Sections - 3.2 Package statement and - 3.3 Import statements).
  3. Command lines in a comment that may be cut-and-pasted into a shell.
-

4.5 Line-wrapping 

-

Terminology Note: When code that might otherwise legally -occupy a single line is divided into multiple lines, typically to avoid overflowing the column -limit, this activity is called -line-wrapping.

There is no comprehensive, deterministic formula showing exactly how to line-wrap in -every situation. Very often there are several valid ways to line-wrap the same piece of code.

Tip: Extracting a method or local variable may solve the problem -without the need to line-wrap.

-

4.5.1 Where to break 

-

The prime directive of line-wrapping is: prefer to break at a -higher syntactic level. Also:

  1. When a line is broken at a non-assignment operator the break comes before - the symbol. (Note that this is not the same practice used in Google style for other languages, - such as C++ and JavaScript.) -
    • This also applies to the following "operator-like" symbols: the dot separator - (.), the ampersand in type bounds - (<T extends Foo & Bar>), and the pipe in - catch blocks - (catch (FooException | BarException e)).
  2. When a line is broken at an assignment operator the break typically comes - after the symbol, but either way is acceptable. -
    • This also applies to the "assignment-operator-like" colon in an enhanced - for ("foreach") statement.
  3. A method or constructor name stays attached to the open parenthesis - (() that follows it.
  4. A comma (,) stays attached to the token that - precedes it.
-

4.5.2 Indent continuation lines at least +4 spaces 

-

When line-wrapping, each line after the first (each continuation line) is indented -at least +4 from the original line.

When there are multiple continuation lines, indentation may be varied beyond +4 as -desired. In general, two continuation lines use the same indentation level if and only if they -begin with syntactically parallel elements.

Section 4.6.3 on Horizontal alignment addresses -the discouraged practice of using a variable number of spaces to align certain tokens with -previous lines.

-

4.6 Whitespace 

- -

4.6.1 Vertical Whitespace 

-

A single blank line appears:

  1. Between consecutive members (or initializers) of a class: fields, constructors, - methods, nested classes, static initializers, instance initializers. -
    • Exception: A blank line between two consecutive - fields (having no other code between them) is optional. Such blank lines are used as needed to - create logical groupings of fields.
  2. Within method bodies, as needed to create logical groupings of statements.
  3. Optionally before the first member or after the last member of the class (neither - encouraged nor discouraged).
  4. As required by other sections of this document (such as Section 3.3, - Import statements).

Multiple consecutive blank lines are permitted, but never required (or encouraged).

-

4.6.2 Horizontal whitespace 

-

Beyond where required by the language or other style rules, and apart from literals, comments and -Javadoc, a single ASCII space also appears in the following places only.

  1. Separating any reserved word, such as - if, - for or - catch, from an open parenthesis - (() - that follows it on that line
  2. Separating any reserved word, such as - else or - catch, from a closing curly brace - (}) that precedes it on that line
  3. Before any open curly brace - ({), with two exceptions: -
    • @SomeAnnotation({a, b}) (no space is used)
    • String[][] x = {{"foo"}}; (no space is required - between {{, by item 8 below)
  4. On both sides of any binary or ternary operator. This also applies to the following - "operator-like" symbols: -
    • the ampersand in a conjunctive type bound: - <T extends Foo & Bar>
    • the pipe for a catch block that handles multiple exceptions: - catch (FooException | BarException e)
    • the colon (:) in an enhanced - for ("foreach") statement
  5. After ,:; or the closing parenthesis - ()) of a cast
  6. On both sides of the double slash (//) that - begins an end-of-line comment. Here, multiple spaces are allowed, but not required.
  7. Between the type and variable of a declaration: - List<String> list
  8. Optional just inside both braces of an array initializer -
    • new int[] {5, 6} and - new int[] { 5, 6 } are both valid

Note: This rule never requires or forbids additional space at the -start or end of a line, only interior space.

-

4.6.3 Horizontal alignment: never required 

-

Terminology Note: Horizontal alignment is the -practice of adding a variable number of additional spaces in your code with the goal of making -certain tokens appear directly below certain other tokens on previous lines.

This practice is permitted, but is never required by Google Style. It is not -even required to maintain horizontal alignment in places where it was already used.

Here is an example without alignment, then using alignment:

-private int x; // this is fine
-private Color color; // this too
-
-private int   x;      // permitted, but future edits
-private Color color;  // may leave it unaligned
-

Tip: Alignment can aid readability, but it creates problems for -future maintenance. Consider a future change that needs to touch just one line. This change may -leave the formerly-pleasing formatting mangled, and that is allowed. More often -it prompts the coder (perhaps you) to adjust whitespace on nearby lines as well, possibly -triggering a cascading series of reformattings. That one-line change now has a "blast radius." -This can at worst result in pointless busywork, but at best it still corrupts version history -information, slows down reviewers and exacerbates merge conflicts.

-

4.7 Grouping parentheses: recommended 

-

Optional grouping parentheses are omitted only when author and reviewer agree that there is no -reasonable chance the code will be misinterpreted without them, nor would they have made the code -easier to read. It is not reasonable to assume that every reader has the entire Java -operator precedence table memorized.

-

4.8 Specific constructs 

- -

4.8.1 Enum classes 

-

After each comma that follows an enum constant, a line-break is optional.

An enum class with no methods and no documentation on its constants may optionally be formatted -as if it were an array initializer (see Section 4.8.3.1 on -array initializers).

-private enum Suit { CLUBS, HEARTS, SPADES, DIAMONDS }
-

Since enum classes are classes, all other rules for formatting classes apply.

-

4.8.2 Variable declarations 

- -
4.8.2.1 One variable per declaration 
-

Every variable declaration (field or local) declares only one variable: declarations such as -int a, b; are not used.

-
4.8.2.2 Declared when needed, initialized as soon as -possible 
-

Local variables are not habitually declared at the start of their containing -block or block-like construct. Instead, local variables are declared close to the point they are -first used (within reason), to minimize their scope. Local variable declarations typically have -initializers, or are initialized immediately after declaration.

-

4.8.3 Arrays 

- -
4.8.3.1 Array initializers: can be "block-like" 
-

Any array initializer may optionally be formatted as if it were a "block-like -construct." For example, the following are all valid (not an exhaustive -list):

-new int[] {           new int[] {
-  0, 1, 2, 3            0,
-}                       1,
-                        2,
-new int[] {             3,
-  0, 1,               }
-  2, 3
-}                     new int[]
-                          {0, 1, 2, 3}
-
-
4.8.3.2 No C-style array declarations 
-

The square brackets form a part of the type, not the variable: -String[] args, not -String args[].

-

4.8.4 Switch statements 

-

Terminology Note: Inside the braces of a -switch block are one or more statement groups. Each statement group consists of -one or more switch labels (either case FOO: or -default:), followed by one or more statements.

-
4.8.4.1 Indentation 
-

As with any other block, the contents of a switch block are indented +2.

After a switch label, a newline appears, and the indentation level is increased +2, exactly as -if a block were being opened. The following switch label returns to the previous indentation -level, as if a block had been closed.

-
4.8.4.2 Fall-through: commented 
-

Within a switch block, each statement group either terminates abruptly (with a -break, -continue, -return or thrown exception), or is marked with a comment -to indicate that execution will or might continue into the next statement group. Any -comment that communicates the idea of fall-through is sufficient (typically -// fall through). This special comment is not required in -the last statement group of the switch block. Example:

-switch (input) {
-  case 1:
-  case 2:
-    prepareOneOrTwo();
-    // fall through
-  case 3:
-    handleOneTwoOrThree();
-    break;
-  default:
-    handleLargeNumber(input);
-}
-
-
4.8.4.3 The default case is present 
-

Each switch statement includes a default statement -group, even if it contains no code.

-

4.8.5 Annotations 

-

Annotations applying to a class, method or constructor appear immediately after the -documentation block, and each annotation is listed on a line of its own (that is, one annotation -per line). These line breaks do not constitute line-wrapping (Section -4.5, Line-wrapping), so the indentation level is not -increased. Example:

-@Override
-@Nullable
-public String getNameIfPresent() { ... }
-

Exception: A single parameterless annotation -may instead appear together with the first line of the signature, for example:

-@Override public int hashCode() { ... }
-

Annotations applying to a field also appear immediately after the documentation block, but in -this case, multiple annotations (possibly parameterized) may be listed on the same line; -for example:

-@Partial @Mock DataLoader loader;
-

There are no specific rules for formatting parameter and local variable annotations.

-

4.8.6 Comments 

- -
4.8.6.1 Block comment style 
-

Block comments are indented at the same level as the surrounding code. They may be in -/* ... */ style or -// ... style. For multi-line -/* ... */ comments, subsequent lines must start with -* aligned with the * on the previous line.

-/*
- * This is          // And so           /* Or you can
- * okay.            // is this.          * even do this. */
- */
-

Comments are not enclosed in boxes drawn with asterisks or other characters.

Tip: When writing multi-line comments, use the -/* ... */ style if you want automatic code formatters to -re-wrap the lines when necessary (paragraph-style). Most formatters don't re-wrap lines in -// ... style comment blocks.

-

4.8.7 Modifiers 

-

Class and member modifiers, when present, appear in the order -recommended by the Java Language Specification: -

-public protected private abstract static final transient volatile synchronized native strictfp
-
-

4.8.8 Numeric Literals 

-

long-valued integer literals use an uppercase L suffix, never -lowercase (to avoid confusion with the digit 1). For example, 3000000000L -rather than 3000000000l.

-

5 Naming 

- -

5.1 Rules common to all identifiers 

-

Identifiers use only ASCII letters and digits, and in two cases noted below, underscores. Thus -each valid identifier name is matched by the regular expression \w+ .

In Google Style special prefixes or -suffixes, like those seen in the examples name_, -mName, s_name and -kName, are not used.

-

5.2 Rules by identifier type 

- -

5.2.1 Package names 

-

Package names are all lowercase, with consecutive words simply concatenated together (no -underscores). For example, com.example.deepspace, not -com.example.deepSpace or -com.example.deep_space.

-

5.2.2 Class names 

-

Class names are written in UpperCamelCase.

Class names are typically nouns or noun phrases. For example, -Character or -ImmutableList. Interface names may also be nouns or -noun phrases (for example, List), but may sometimes be -adjectives or adjective phrases instead (for example, -Readable).

There are no specific rules or even well-established conventions for naming annotation types.

Test classes are named starting with the name of the class they are testing, and ending -with Test. For example, -HashTest or -HashIntegrationTest.

-

5.2.3 Method names 

-

Method names are written in lowerCamelCase.

Method names are typically verbs or verb phrases. For example, -sendMessage or -stop.

Underscores may appear in JUnit test method names to separate logical components of the -name. One typical pattern is test<MethodUnderTest>_<state>, -for example testPop_emptyStack. There is no One Correct -Way to name test methods.

-

5.2.4 Constant names 

-

Constant names use CONSTANT_CASE: all uppercase -letters, with words separated by underscores. But what is a constant, exactly?

Every constant is a static final field, but not all static final fields are constants. Before -choosing constant case, consider whether the field really feels like a constant. For -example, if any of that instance's observable state can change, it is almost certainly not a -constant. Merely intending to never mutate the object is generally not -enough. Examples:

-// Constants
-static final int NUMBER = 5;
-static final ImmutableList<String> NAMES = ImmutableList.of("Ed", "Ann");
-static final Joiner COMMA_JOINER = Joiner.on(',');  // because Joiner is immutable
-static final SomeMutableType[] EMPTY_ARRAY = {};
-enum SomeEnum { ENUM_CONSTANT }
-
-// Not constants
-static String nonFinal = "non-final";
-final String nonStatic = "non-static";
-static final Set<String> mutableCollection = new HashSet<String>();
-static final ImmutableSet<SomeMutableType> mutableElements = ImmutableSet.of(mutable);
-static final Logger logger = Logger.getLogger(MyClass.getName());
-static final String[] nonEmptyArray = {"these", "can", "change"};
-

These names are typically nouns or noun phrases.

-

5.2.5 Non-constant field names 

-

Non-constant field names (static or otherwise) are written -in lowerCamelCase.

These names are typically nouns or noun phrases. For example, -computedValues or -index.

-

5.2.6 Parameter names 

-

Parameter names are written in lowerCamelCase.

One-character parameter names should be avoided.

-

5.2.7 Local variable names 

-

Local variable names are written in lowerCamelCase, and can be -abbreviated more liberally than other types of names.

However, one-character names should be avoided, except for temporary and looping variables.

Even when final and immutable, local variables are not considered to be constants, and should not -be styled as constants.

-

5.2.8 Type variable names 

-

Each type variable is named in one of two styles:

  • A single capital letter, optionally followed by a single numeral (such as - E, T, - X, T2) -
  • A name in the form used for classes (see Section 5.2.2, - Class names), followed by the capital letter - T (examples: - RequestT, - FooBarT).
-

5.3 Camel case: defined 

-

Sometimes there is more than one reasonable way to convert an English phrase into camel case, -such as when acronyms or unusual constructs like "IPv6" or "iOS" are present. To improve -predictability, Google Style specifies the following (nearly) deterministic scheme.

Beginning with the prose form of the name:

  1. Convert the phrase to plain ASCII and remove any apostrophes. For example, "Müller's - algorithm" might become "Muellers algorithm".
  2. Divide this result into words, splitting on spaces and any remaining punctuation (typically - hyphens). - -
    • Recommended: if any word already has a conventional camel-case appearance in common - usage, split this into its constituent parts (e.g., "AdWords" becomes "ad words"). Note - that a word such as "iOS" is not really in camel case per se; it defies any - convention, so this recommendation does not apply.
  3. Now lowercase everything (including acronyms), then uppercase only the first - character of: -
    • ... each word, to yield upper camel case, or
    • ... each word except the first, to yield lower camel case
  4. Finally, join all the words into a single identifier.

Note that the casing of the original words is almost entirely disregarded. Examples:

Prose formCorrectIncorrect
"XML HTTP request"XmlHttpRequestXMLHTTPRequest
"new customer ID"newCustomerIdnewCustomerID
"inner stopwatch"innerStopwatchinnerStopWatch
"supports IPv6 on iOS?"supportsIpv6OnIossupportsIPv6OnIOS
"YouTube importer"YouTubeImporter
YoutubeImporter*

*Acceptable, but not recommended.

Note: Some words are ambiguously hyphenated in the English -language: for example "nonempty" and "non-empty" are both correct, so the method names -checkNonempty and -checkNonEmpty are likewise both correct.

-

6 Programming Practices 

- -

6.1 @Override: always used 

-

A method is marked with the @Override annotation -whenever it is legal. This includes a class method overriding a superclass method, a class method -implementing an interface method, and an interface method respecifying a superinterface -method.

Exception:@Override may be omitted when the parent method is -@Deprecated.

-

6.2 Caught exceptions: not ignored 

-

Except as noted below, it is very rarely correct to do nothing in response to a caught -exception. (Typical responses are to log it, or if it is considered "impossible", rethrow it as an -AssertionError.)

When it truly is appropriate to take no action whatsoever in a catch block, the reason this is -justified is explained in a comment.

-try {
-  int i = Integer.parseInt(response);
-  return handleNumericResponse(i);
-} catch (NumberFormatException ok) {
-  // it's not numeric; that's fine, just continue
-}
-return handleTextResponse(response);
-

Exception: In tests, a caught exception may be ignored -without comment if it is named expected. The -following is a very common idiom for ensuring that the method under test does throw an -exception of the expected type, so a comment is unnecessary here.

-try {
-  emptyStack.pop();
-  fail();
-} catch (NoSuchElementException expected) {
-}
-
-

6.3 Static members: qualified using class 

-

When a reference to a static class member must be qualified, it is qualified with that class's -name, not with a reference or expression of that class's type.

-Foo aFoo = ...;
-Foo.aStaticMethod(); // good
-aFoo.aStaticMethod(); // bad
-somethingThatYieldsAFoo().aStaticMethod(); // very bad
-
-

6.4 Finalizers: not used 

-

It is extremely rare to override Object.finalize.

Tip: Don't do it. If you absolutely must, first read and understand -Effective Java -Item 7, "Avoid Finalizers," very carefully, and then don't do it.

-

7 Javadoc 

- -

7.1 Formatting 

- -

7.1.1 General form 

-

The basic formatting of Javadoc blocks is as seen in this example:

-/**
- * Multiple lines of Javadoc text are written here,
- * wrapped normally...
- */
-public int method(String p1) { ... }
-

... or in this single-line example:

-/** An especially short bit of Javadoc. */
-

The basic form is always acceptable. The single-line form may be substituted when there are no -at-clauses present, and the entirety of the Javadoc block (including comment markers) can fit on a -single line.

-

7.1.2 Paragraphs 

-

One blank line—that is, a line containing only the aligned leading asterisk -(*)—appears between paragraphs, and before the group of "at-clauses" if -present. Each paragraph but the first has <p> immediately before the first word, -with no space after.

-

7.1.3 At-clauses 

-

Any of the standard "at-clauses" that are used appear in the order @param, -@return, @throws, @deprecated, and these four types never -appear with an empty description. When an at-clause doesn't fit on a single line, continuation lines -are indented four (or more) spaces from the position of the @. -

-

7.2 The summary fragment 

-

The Javadoc for each class and member begins with a brief summary fragment. This -fragment is very important: it is the only part of the text that appears in certain contexts such as -class and method indexes.

This is a fragment—a noun phrase or verb phrase, not a complete sentence. It does -not begin with A {@code Foo} is a..., or -This method returns..., nor does it form a complete imperative sentence -like Save the record.. However, the fragment is capitalized and -punctuated as if it were a complete sentence.

Tip: A common mistake is to write simple Javadoc in the form -/** @return the customer ID */. This is incorrect, and should be -changed to /** Returns the customer ID. */.

-

7.3 Where Javadoc is used 

-

At the minimum, Javadoc is present for every -public class, and every -public or -protected member of such a class, with a few exceptions -noted below.

Other classes and members still have Javadoc as needed. Whenever an implementation -comment would be used to define the overall purpose or behavior of a class, method or field, that -comment is written as Javadoc instead. (It's more uniform, and more tool-friendly.)

-

7.3.1 Exception: self-explanatory methods 

-

Javadoc is optional for "simple, obvious" methods like -getFoo, in cases where there really and truly is -nothing else worthwhile to say but "Returns the foo".

Important: it is not appropriate to cite this exception to justify -omitting relevant information that a typical reader might need to know. For example, for a method -named getCanonicalName, don't omit its documentation -(with the rationale that it would say only -/** Returns the canonical name. */) if a typical reader may have no idea -what the term "canonical name" means!

-

7.3.2 Exception: overrides 

-

Javadoc is not always present on a method that overrides a supertype method. -

-
Last changed: March 21, 2014
- - diff --git a/javaguidelink.png b/javaguidelink.png deleted file mode 100644 index 75d5c7ba8dcc22b100b18b8c800da9ed99afbf7b..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 189 zcmeAS@N?(olHy`uVBq!ia0vp^q9Dw{1|(OCFP#RYT0C7GLo80eoovW;K!L}#nDP3f zLaS;${>#Z0UFCva2M?aC%WS)H?QB_5g+S7$o~{tDg%>YO@zZ2dVrDwAKuzez0i`Ul zbE@l3-bt1V61%3rbUmT<%Dy%3?@ZTjdAE&Ol|^ce?3NY5cci0UGX8nXab09-b9Pp3 o=^vw)Kdk>g`TD$n)}_KZpTAr6giAPD0^P&l>FVdQ&MBb@0Ar|2