Document include guard convention

wumintendy · Mar 22, 2018 · 8af65d9 · 8af65d9
1 parent 6d36f59
commit 8af65d9
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/doc/developer-notes.md b/doc/developer-notes.md
@@ -514,6 +514,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
 -----