This is a draft cheat sheet. It is a work in progress and is not finished yet.
Description
Legend of used icons |
|
mandatory rule |
|
recommended rule |
File Names
shall equal class name if associated with class (same case and spelling) |
Suffix .h for headers and .cpp for implementation files |
|
|
Naming conventions
names shall only contain letters, digits and underscore (No underscore at beginning, no sequence of underscores) |
use CamelCase (the first letter of each word capitalized) |
Types |
shall start with a capital letter |
should be nouns |
Variables |
Private and protected member variables shall be prefixed with m |
should not contain abbreviations of their type (no Hungarian notation) |
Functions |
should be verbs |
Name Spaces |
Names of name spaces shall only contain letters and digits |
Examples: mMyMemberVariable; ImportantNumber; Var_With_UnderScore
Invalid: _SuperSecretVar; Sequence__Of___UnderScores
Name Space Names
shall only contain letters and digits |
|