for_developers:style_guide
Differences
This shows you the differences between two versions of the page.
Next revision | Previous revision | ||
for_developers:style_guide [2015/04/01 10:37] – external edit 127.0.0.1 | for_developers:style_guide [2021/06/09 18:31] (current) – [Code Documentation] ursgraf | ||
---|---|---|---|
Line 1: | Line 1: | ||
====== Coding Style Guide ====== | ====== Coding Style Guide ====== | ||
- | EEROS is written primarily in C++, and its developers follow the [[https:// | + | EEROS is written primarily in C++, and its developers follow the [[https:// |
=== #define Guards === | === #define Guards === | ||
Line 24: | Line 24: | ||
=== File Names and Extensions === | === File Names and Extensions === | ||
- | + | * File names | |
- | File names: | + | |
- | + | | |
- | File names should be the same as the class name. For example, for the class ExampleClass the header file is ExampleClass.hpp and the source file ExampleClass.cpp | + | |
- | + | | |
- | If there is more then one class defined in a single file, we use the module name for the file name. A module name always starts with a small letter (e.g. exampleModule.cpp) | + | |
- | + | ||
- | File extensions: | + | |
- | + | ||
- | C++ Source Code: use .cpp | + | |
- | C++ Headerfiles: | + | |
=== Variable Names === | === Variable Names === | ||
Line 58: | Line 53: | ||
tableName_ | tableName_ | ||
</ | </ | ||
+ | |||
+ | |||
+ | |||
+ | |||
+ | ==== Code Documentation ==== | ||
+ | |||
+ | * The documentation of the code is done with Doxygen. | ||
+ | * The code is documented in the declaration, | ||
+ | * Whenever possible the definition should be separated from the declaration. | ||
+ | * Templates have to be defined directly in the hpp-file. In that case, the documentation will be added there. | ||
+ | |||
+ | |||
for_developers/style_guide.1427877444.txt.gz · Last modified: 2016/02/12 09:32 (external edit)