for_developers:style_guide
Differences
This shows you the differences between two versions of the page.
| Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
| for_developers:style_guide [2016/12/18 15:31] – 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 60: | Line 60: | ||
| * The documentation of the code is done with Doxygen. | * The documentation of the code is done with Doxygen. | ||
| - | * The code is documented in the definition, never in the declaration. | + | * The code is documented in the declaration, never in the definition. |
| * Whenever possible the definition should be separated from 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. | * Templates have to be defined directly in the hpp-file. In that case, the documentation will be added there. | ||
for_developers/style_guide.txt · Last modified: 2021/06/09 18:31 by ursgraf