Difference between revisions of "Coding Conventions & Style"
From MNE-CPP Wiki
| Line 25: | Line 25: | ||
'''Using Doxygen:''' | '''Using Doxygen:''' | ||
| − | Please use DoxyGen as shown in the TemplateClass [https://raw.githubusercontent.com/mne-tools/mne-cpp/master/tools/coding_conventions/qtCreator_wizard/mne_templates/templateclass.h header] and [https://raw.githubusercontent.com/mne-tools/mne-cpp/master/tools/coding_conventions/qtCreator_wizard/mne_templates/templateclass.cpp source] files. 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 | + | Please use DoxyGen as shown in the TemplateClass [https://raw.githubusercontent.com/mne-tools/mne-cpp/master/tools/coding_conventions/qtCreator_wizard/mne_templates/templateclass.h header] and [https://raw.githubusercontent.com/mne-tools/mne-cpp/master/tools/coding_conventions/qtCreator_wizard/mne_templates/templateclass.cpp source] files. 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 address). Also add the current date and all other necessary descriptions. We strongly recommend to make use of the MNE-CPP QtCreator wizard (you can find the installation guide [[Setup the MNE-CPP QtCreator wizard|'''here''']]). |
Revision as of 15:00, 31 January 2018
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 |
| Local variables | 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. 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 address). Also add the current date and all other necessary descriptions. We strongly recommend to make use of the MNE-CPP QtCreator wizard (you can find the installation guide here).
