Skip to content
Siraj Razick edited this page Feb 14, 2016 · 6 revisions

Basic Rules

  • Avoid indenting namespaces.
  • Use Camel Case for Class Names and starts with a lower case.
  • Use Camel case for member functions and starts with a lowercase letter and separated by "_" under scores. ex: Window::create_window(); . this will help us distinguish Qt api calls.
  • 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 "sh_ptr"
  • 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.
  • Coding Guidelines

Clone this wiki locally