for_developers:style_guide
Differences
This shows you the differences between two versions of the page.
| Both sides previous revisionPrevious revision | |||
| for_developers:style_guide [2019/01/22 17:06] – update broken link. kunz | for_developers:style_guide [2021/06/09 18:31] (current) – [Code Documentation] ursgraf | ||
|---|---|---|---|
| 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.1548173209.txt.gz · Last modified: 2019/01/22 17:06 by kunz