Commit a2fd9a3
doc: add *-inl.h include rule to C++ style guide
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>1 parent 255fffb commit a2fd9a3
1 file changed
Lines changed: 15 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -127,6 +127,21 @@ class FancyContainer { | |||
| 127 | 127 | ||
| 128 | 128 | What it says in the title. | |
| 129 | 129 | ||
| 130 | + ## Do not include `*.h` if `*-inl.h` has already been included | ||
| 131 | + | ||
| 132 | + Do | ||
| 133 | + | ||
| 134 | + ```cpp | ||
| 135 | + #include "util-inl.h" // already includes util.h | ||
| 136 | + ``` | ||
| 137 | + | ||
| 138 | + instead of | ||
| 139 | + | ||
| 140 | + ```cpp | ||
| 141 | + #include "util.h" | ||
| 142 | + #include "util-inl.h" | ||
| 143 | + ``` | ||
| 144 | + | ||
| 130 | 145 | ## Avoid throwing JavaScript errors in nested C++ methods | |
| 131 | 146 | ||
| 132 | 147 | If you need to throw JavaScript errors from a C++ binding method, try to do it | |
0 commit comments