![]() |
a .cpp file always include the corresponding header file first
In many articles, there is such a coding guideline:
>> On a .cpp file always include the corresponding header file first, like this: Code:
// This is Foo.cppWhy it can make sure the header file is self-contained by including the header file first in the corresponding implementation file? Can anybody explain it a little bit more? |
Re: a .cpp file always include the corresponding header file first
By making sure that foo.h includes gromit.h and widget.h automatically, you save having to explain to all users of foo.h the need to include the other two files, and save having to remind them should they accidentally forget.
If at some future time, foo.h removed gromit.h and adds wallace.h, then all the users of foo.h don't have to go round changing many thousands of instances of including foo.h to fix the pre-requisite headers. |
Re: a .cpp file always include the corresponding header file first
Salem, thanks for your answer. But it seems you explained the advantage of making the header file "self-contained".
My question is: Why "a .cpp file always include the corresponding header file first (see example above)" is able to check whether the header file is self-contained? What will happen if I include other header files before the corresponding header file of that .cpp file? |
Re: a .cpp file always include the corresponding header file first
By being included first is how it checks.
|
Re: a .cpp file always include the corresponding header file first
Quote:
|
Re: a .cpp file always include the corresponding header file first
Quote:
Quote:
I get a little confused. |
Re: a .cpp file always include the corresponding header file first
I could not get the meaning of the post you are quoting though.
|
Re: a .cpp file always include the corresponding header file first
Well if you had this
Code:
#include "other.h"But by having this Code:
#include "myHeader.h"Either myHeader.h doesn't depend on other.h, or it does depend on other.h and it (myHeader.h) includes other.h as well. So by including it first, you guarantee that it has no hidden dependencies (otherwise it would fail to compile). This gives confidence that anyone else who needs myHeader.h can include it without having to worry about dependencies. |
Re: a .cpp file always include the corresponding header file first
So there is no conflict now because what I said was syntactically correct and what Salem is saying is what you should be doing for better understanding of code.
|
Re: a .cpp file always include the corresponding header file first
use
#pragma once In case of to avoid too many times including the same header file |
| All times are GMT +5.5. The time now is 16:32. |