diff options
| author | MarcoFalke <falke.marco@gmail.com> | 2018-04-01 18:30:17 -0400 |
|---|---|---|
| committer | MarcoFalke <falke.marco@gmail.com> | 2018-04-01 18:30:21 -0400 |
| commit | 0c5f67b8e5d9a502c6d321c5e0696bc3e9b4690d (patch) | |
| tree | 157e9d84196abfbdb59270e3829e6b0cb4c4bde2 /doc | |
| parent | 9beded58606606b00e70ae76020ac433569b901e (diff) | |
| parent | 3bcc0059b82b1d482d499d4d8f09118617074a5b (diff) | |
Merge #12757: Clarify include guard naming convention
3bcc0059b8 Add lint-include-guards.sh which checks include guard consistency (practicalswift)
8fd6af89a0 Fix missing or inconsistent include guards (practicalswift)
8af65d96f4 Document include guard convention (practicalswift)
Pull request description:
* **Documentation**: Document include guard convention
* **Fix**: Fix missing or inconsistent include guards
* **Regression test**: Add `lint-include-guards.sh` which checks include guard consistency
Tree-SHA512: 8171878f60fd08ccbea943a11e835195750592abb9d7ab74eaa4265ae7fac523b1da9d31ca13d6ab73dd596e49986bfb7593c696e5f39567c93e610165bc2acc
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/developer-notes.md | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/doc/developer-notes.md b/doc/developer-notes.md index 7a033b28d4..540f2e8b84 100644 --- a/doc/developer-notes.md +++ b/doc/developer-notes.md @@ -606,6 +606,16 @@ namespace { source file into account. This allows quoted includes to stand out more when the location of the source file actually is relevant. +- Use include guards to avoid the problem of double inclusion. The header file + `foo/bar.h` should use the include guard identifier `BITCOIN_FOO_BAR_H`, e.g. + +```c++ +#ifndef BITCOIN_FOO_BAR_H +#define BITCOIN_FOO_BAR_H +... +#endif // BITCOIN_FOO_BAR_H +``` + GUI ----- |