OpenCascade/occt
1
0
Fork 0
mirror of https://git.dev.opencascade.org/repos/occt.git synced 2025-04-05 18:16:23 +03:00
Code Packages Releases Activity

0029228: Coding Rules - define rule for avoiding header inclusion list pollution

Browse Source
This commit is contained in:
kgv 2017-10-13 18:49:18 +03:00 committed by bugmaster
parent 4ea76aea75
commit 744d9c0d22
1 changed files with 2 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
dox/dev_guides/contribution/coding_rules.md
View File

@ -479,6 +479,8 @@ Inclusion of class header on top verifies consistency of the header (e.g. that h
An exception to the rule is ordering system headers generating a macros declaration conflicts (like "windows.h" or "X11/Xlib.h") - these headers should be placed in the way solving the conflict. An exception to the rule is ordering system headers generating a macros declaration conflicts (like "windows.h" or "X11/Xlib.h") - these headers should be placed in the way solving the conflict.
The source or header file should include only minimal set of headers necessary for compilation, without duplicates (considering nested includes).
~~~~~{.cpp} ~~~~~{.cpp}
// the header file of implemented class // the header file of implemented class
#include <PackageName_ClassName.hxx> #include <PackageName_ClassName.hxx>