OBJECT ORIENTED PROGRAMMING

Summary Google C++ Style Guide

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.

General Naming Rules

Names should be descriptive. Avoid abbreviation.

int price_count_reader; // OK
int pc_reader; 			// Bad

File Names

Filenames should be all lowercase and can include underscores (_) or dashes (-).

my_useful_class.cc
myusefulclass.cc

Type Names

Type names should start with a capital letter and have a capital letter for each new word. No underscores.

// classes and structs
class UrlTable { ...
class UrlTableTester { ...
struct UrlTableProperties { ...

Variable Names

Variable names are all lowercase, with underscore between words.

string table_name;  // OK
string tableName;   // Bad

Data members of classes, are named like ordinary nonmember variables, but with a trailing underscore.

class TableInfo {
   ...
  private:
    string table_name_;
};

Data members of structs, are named like ordinary nonmember variables.

Constant Names

Variables declared const, and whose value is fixed for the duration of the programare with a leading "k" followed by mixed case.

const int kDaysInAWeek = 7;

Function Names

Regular functions have mixed case.

AddTableEntry()
OpenFileOrDie()

"Cheap" functions may use lower case with underscores. A canonical example is an inline method that just returns one of the class's member variables.

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

Comments

Comment Style

File Comments

Class Comments

Function Comments

Variable Comments

Implementation Comments

Punctuation, Spelling and Grammar

TODO Comments