doc: add *-inl.h include rule to C++ style guide

joyeecheung · gibfahn · commit a2fd9a3cf217 · 2017-11-14T16:34:32.000Z
PR-URL: #16548 Backport-PR-URL: #16609 Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl> Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com> Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com> Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
diff --git a/CPP_STYLE_GUIDE.md b/CPP_STYLE_GUIDE.md
@@ -127,6 +127,21 @@ class FancyContainer {
 
 What it says in the title.
 
+## Do not include `*.h` if `*-inl.h` has already been included
+
+Do
+
+```cpp
+#include "util-inl.h"  // already includes util.h
+```
+
+instead of
+
+```cpp
+#include "util.h"
+#include "util-inl.h"
+```
+
 ## Avoid throwing JavaScript errors in nested C++ methods
 
 If you need to throw JavaScript errors from a C++ binding method, try to do it
