Code style guide

Table of Contents

• General naming rules
  • Variables
  • Classes
  • Functions
• Class guidelines

General naming rules

Variables

Snake case

int my_var_in_degrees_c;

Classes

Pascal case: each word starts by an uppercase including the first letter

class MyClass;
class MyOtherClass;
struct MyStruct;

Private Data members always start with m_

class MyClass
{
private:
    int m_my_int;
};

Functions

Camel case : each word starts by an uppercase except the first one

void myFunction(int param1, int param2);

Function params use the same case as variables

void myOtherFunction(int param1, int my_other_param);

Class guidelines

• Every non static data member of a class should be private
• Default dtors and ctors MUST be deleted or implementend
• Every getters MUST have a const variant
• If you create an RAII class, you SHOULD declare move ctors