Skip to content

SF.12: Prefer the quoted form of #include for files relative to the… #1596

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 9 commits into from
Jul 25, 2020
Merged

SF.12: Prefer the quoted form of #include for files relative to the… #1596

Changes from 1 commit
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
e47463c
SF.12: Prefer the quoted form of `#include` for files relative to the…
apenn-msft Apr 2, 2020
66792e4
Update wording and examples for SF.12: Prefer the quoted form of `#in…
apenn-msft Apr 3, 2020
30ef5b8
update code markdown for #include
apenn-msft Apr 3, 2020
bbc2f4d
Merge branch 'master' into patch-1
apenn-msft Apr 22, 2020
426ac87
updated wording around use of <> for projects
apenn-msft Apr 22, 2020
4e61010
keep wording more consistent
apenn-msft Apr 23, 2020
f4c8092
Update CppCoreGuidelines.md
apenn-msft Apr 25, 2020
f458ada
Update CppCoreGuidelines.md
apenn-msft Jul 23, 2020
94d6123
relative path should be from within the same component
apenn-msft Jul 24, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions CppCoreGuidelines.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19189,12 +19189,13 @@ The [standard](http://eel.is/c++draft/cpp.include) provides flexibility for comp
the two forms of `#include` selected using the angle (`<>`) or quoted (`""`) syntax. Vendors take
advantage of this and use different search algorithms and methods for specifying the include path.

Nevertheless, the guidance is to use the quoted form for including files that exist at a relative path to the file containing the `#include` statement and to use the angle bracket form everywhere else, where possible. This encourages being clear about the locality of the header relative to files that include it, or scenarios where the different search algorithm is required. For example, it makes it easy to understand at a glance whether a header is being included from a local relative file versus a standard library header or an external header from another project.
Nevertheless, the guidance is to use the quoted form for including files that exist at a relative path to the file containing the `#include` statement and to use the angle bracket form everywhere else, where possible. This encourages being clear about the locality of the header relative to files that include it, or scenarios where the different search algorithm is required. It makes it easy to understand at a glance whether a header is being included from a local relative file versus a standard library header or a header from the alternate search path (e.g. a header from another project or a common set of includes).

##### Example

// foo.cpp:
#include <string> // From the standard library, requires the <> form
#include <some_library/common.h> // A file that is not locally relative, included from an external project; use the <> form
#include <some_library/common.h> // A file that is not locally relative, included from another project; use the <> form
#include "foo.h" // A file locally relative to foo.cpp, use the "" form
#include "foo_utils/utils.h" // A file locally relative to foo.cpp, use "" form

Expand Down