Menu

Coding Guidelines.

Siraj Razick

Basic Rules

  • Avoid indenting namespaces.
  • Use Camel Case for Class Names and starts with a Uppercase letter.
  • Use Camel case for member functions and starts with a lowercase letter.
  • Argument variable name should be prefixed with letter 'a'
  • Member variables should be prefixed with letter 'm'
  • Pointers should have a postfix "Ptr"
  • Shared pointers should have a postfix "ShPtr"
  • Use Astyle Gist to auto indent code.
  • Each line should never exceed 80 char's
  • Use Opaque pointers in public API headers.
  • C++ API documentation should be compatible with Doxygen
  • Doxygen comments should be added to the implementation files (.cpp).
  • Include guards in header files should be named as : NAMESPACE_CLASS_NAME_H
  • Logically related member functions should be grouped and non related functions should be separated by a new line.