diff options
author | Jean-François Milants <jf@codingfield.com> | 2021-11-28 13:53:22 +0100 |
---|---|---|
committer | Jean-François Milants <jf@codingfield.com> | 2021-11-28 13:53:22 +0100 |
commit | 67e077348c4e20b7c11701e468d89159b9473489 (patch) | |
tree | bdc0d80d48c215d395a7ee69bdd80c66cc8e2159 /doc/coding-convention.md | |
parent | d5e8e3ca44e998511907d1ec74c98c06c2e542b8 (diff) | |
parent | 298f0f43357c5fd12c4498d74a35d71a0501ae1a (diff) |
Merge branch 'NeroBurner-restructure_includes' into develop
Diffstat (limited to 'doc/coding-convention.md')
-rw-r--r-- | doc/coding-convention.md | 1 |
1 files changed, 1 insertions, 0 deletions
diff --git a/doc/coding-convention.md b/doc/coding-convention.md index 6672d54d..7198fa4f 100644 --- a/doc/coding-convention.md +++ b/doc/coding-convention.md @@ -31,6 +31,7 @@ If there are no preconfigured rules for your IDE, you can use one of the existin - **Includes** : - files from the project : `#include "relative/path/to/the/file.h"` - external files and std : `#include <file.h>` + - use includes relative to included directories like `src`, not relative to the current file. Don't do: `#include "../file.h"` - Only use [primary spellings for operators and tokens](https://en.cppreference.com/w/cpp/language/operator_alternative) - Use auto sparingly. Don't use auto for [fundamental/built-in types](https://en.cppreference.com/w/cpp/language/types) and [fixed width integer types](https://en.cppreference.com/w/cpp/types/integer), except when initializing with a cast to avoid duplicating the type name. - Examples: |