for_developers:style_guide
Differences
This shows you the differences between two versions of the page.
| Next revisionBoth sides next revision | |||
| for_developers:style_guide [2015/04/01 10:37] – external edit 127.0.0.1 | for_developers:style_guide [2016/02/12 09:32] – abajric | ||
|---|---|---|---|
| Line 58: | Line 58: | ||
| tableName_ | tableName_ | ||
| </ | </ | ||
| + | |||
| + | |||
| + | |||
| + | |||
| + | ==== Code Documentation ==== | ||
| + | |||
| + | * The documentation of the code is done with Doxygen. | ||
| + | * The code is documented in the definition, never 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.txt · Last modified: 2021/06/09 18:31 by ursgraf