| ... | ... | @@ -271,7 +271,9 @@ Important rules, and notable differences are summarized here: |
|
|
|
|
|
|
|
|
|
|
|
## General Rules
|
|
|
|
|
|
|
|
- Don't use ```using namespace ;``` or ```using symbol``` in a header file to inject alien definitions into the "corsika::" namespace (if not absolutely and fundamentally necessary). Do this only inside local scope, e.g. functions.
|
|
|
|
- Only include headers that you need. If you remove functionality, also remove header files! Include header files as local as possible.
|
|
|
|
- Basically never use "iostream" cout, cerr, and endl. We use our own logging machinery based on spdlog!
|
|
|
|
- Test your code with ```-pedantic``` compiler flag enabled.
|
|
|
|
- Warnings have to be fixed, when they appear on the system(s) currently used by the CI, by altering the code unless the warning originates from third-party code and cannot be fixed. In such cases, developers of the third-party project should be informed. Should the warning be locally silenced, either using appropriate pragmas or locally turning off warnings for that translation unit, documentation should be added in the entry point triggering the
|
|
|
|
warning using the flag ```"FIXME"``` as keyword.
|
| ... | ... | |
