Coding Conventions & Style

From MNE-CPP Wiki
Revision as of 17:20, 31 January 2018 by LorenzE (Talk | contribs)

Jump to: navigation, search

The QtCreator Wizard:

We strongly recommend to make use of the MNE-CPP QtCreator wizard to add new classe to any project (you can find the installation guide here).

Naming Conventions:

Please make use of the following coding conventions as soon as you plan to contribute to MNE-CPP.

Object Rule
Namespace MYNAMESPACE
Classes MyClass
Member functions myFunction
Member variables m_typeMeaningfulName
Local variables typeMeaningfulName

Readability and Understandability:

  • Avoid complex and condensed expressions
  • Use meaningful variable names

Using Doxygen:

Please use the DoxyGen style to document your code.