Index

Project Layout

include/ ::= a folder that contains the distributed .h (header files)

src ::= a folder that contains source code or implementation files .cpp

build ::= a folder that is sometimes there for holding onto build scripts, half-built code, other stuff related to the compilation process

Google's CPP standards should be followed, here's a gist.

Every .cpp code should have an associated .h file.
Header files should be self-contained (compiles on their own).
Use #pragma once at the beginning of the header files to prevent multiple inclusion.
Avoid forward declarations as much as possible.
Header files should only contain declarations. Define functions inline only when they are small, 10 lines or less.

Use names that describe the purpose or intent of the object. Do not worry about saving horizontal space as it is far more important to make your code immediately understandable by a new reader. Minimize the use of abbreviations that would likely be unknown to someone outside your project (especially acronyms and initialisms). Do not abbreviate by deleting letters within a word. As a rule of thumb, an abbreviation is probably OK if it's listed in Wikipedia. Generally speaking, descriptiveness should be proportional to the name's scope of visibility. For example, n may be a fine name within a 5-line function, but within the scope of a class, it's likely too vague.
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, type aliases, 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.

3.The names of variables (including function parameters) and data members are all lowercase, with underscores between words.

Private static and non-static, are named like ordinary nonmember variables, but with a trailing underscore whereas public static and non-static members are named exactly like ordinary nonmember variables.
Variables declared constexpr or const, and whose value is fixed for the duration of the program, are named with a leading "g_" with snake case.
Function members should be name with snake_case.

Use java style comments without initiating asterisks every newline. The comment should appear right before the declaration of the class, struct or member.

/**
 The trivial static object 
 finding my way homeeeee 
 What is the meaning of that 
*/