Recommend #include<> syntax in developer notes

7 years ago · 434f5a2506
1 changed files with 8 additions and 0 deletions
--- a/doc/developer-notes.md
+++ b/doc/developer-notes.md
@ -492,6 +492,14 @@ namespace {
				@@ -492,6 +492,14 @@ namespace {

  - *Rationale*: Avoids confusion about the namespace context

+- Prefer `#include <primitives/transaction.h>` bracket syntax instead of
+  `#include "primitives/transactions.h"`` quote syntax when possible.
+
+  - *Rationale*: Bracket syntax is less ambiguous because the preprocessor
+    searches a fixed list of include directories without taking location of the
+    source file into account. This allows quoted includes to stand out more when
+    the location of the source file actually is relevant.
+
 GUI
 -----