Coding Conventions & Style

From MNE-CPP Wiki
Revision as of 18:44, 4 January 2016 by LorenzE (Talk | contribs)

Jump to: navigation, search

Template Class Headers and Source files:

Please see the TemplateClass header and source files in mne-cpp/tools/coding_conventions/Template_Class for an example how to structure your classes.

Naming Conventions:

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

Readability and Understandability:

  • Avoid complex and condensed expressions
  • use meaningful variable names

Using Doxygen:

Please use DoxyGen as shown in the TemplateClass header and source files in mne-cpp/tools/coding_conventions/Template_Class. Don't forget to change the documentation header in the header and source file. It should always include the file's and your name (E-Mail adress). Also add the current date and all other necessary descriptions.