From 434f5a2506e982210226cfd24421f381e20173f3 Mon Sep 17 00:00:00 2001 From: Russell Yanofsky Date: Tue, 15 Aug 2017 13:45:16 -0400 Subject: Recommend #include<> syntax in developer notes --- doc/developer-notes.md | 8 ++++++++ 1 file changed, 8 insertions(+) (limited to 'doc/developer-notes.md') diff --git a/doc/developer-notes.md b/doc/developer-notes.md index 35797da7ae..7f34b07d15 100644 --- a/doc/developer-notes.md +++ b/doc/developer-notes.md @@ -492,6 +492,14 @@ namespace { - *Rationale*: Avoids confusion about the namespace context +- Prefer `#include ` 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 ----- -- cgit v1.2.3