在 Visual Studio 中包含头文件

Question

假设我有一个包含 3 个项目 X、Y 和 E 的解决方案。

E 将生成可执行文件，X 和 Y 将生成静态库，使得 Y 包含 < code>X和E包含Y的头文件。

现在，我的问题是：为什么我必须在E中包含X的头文件目录？

Answer 1

原因如下：

1. 项目 Y 中的某些函数可能采用 X 中声明的类型的参数（或返回值）。
2. 如果是这样，编译器可能必须在编译 E 时创建这些参数（或返回值）对象。
3. 如果是这样的话，E 中绝对需要来自 X 的头文件。

Answer 2

如果您构造 Y 使其对 X 的依赖关系完全封装，则可以避免这种情况。这可能可行，也可能不可能，具体取决于 X 和 Y 的具体情况。但是，如果 Y 向 E 呈现的接口不需要包含 X 的任何详细信息，那么 E 项目甚至不需要间接包含来自 X 的标头。在这种情况下，只有 Y 的实现文件（.c 或 .cpp 文件）将包含来自 X 的标头。在 Y 标头中对 X 中的类型使用前向声明可以帮助实现 X 在 Y 中的封装

。是一个值得实现的好目标，但它可能并不总是可能实现，即使有可能，它也可能比您（或您的管理层）想要付出的努力更多。

Answer 3

有时可以重组 C++ 的头文件以使用前向声明来避免您所描述的情况。下面是一个示例：C++ 标头依赖技巧。

一个简单的案例：

Xh

class X {
  //...
};

Yh

// #include <X.h> -- remove this
class X; // add forward declaration
class Y {
  X *m_px; // must be a pointer, not a value,
           // otherwise the size of X would need to be known
  //...
};

Y.cpp

#include <X.h> // need to add it here
//...

Answer 4

简短回答：“为什么我必须在 E 中包含 X 的头文件目录？”...你不应该。 Y 的客户端不必知道 Y 依赖于 X。

---

长答案： 仅当 Y 的接口（签名）使用在 E 中声明的内容时，才需要在 E 中包含 X 的标头但是，如果 Y 的标头是“正确构造的”，那么它们将在 Y 标头本身中包含 X 的标头，并且您不必在 E 中显式包含 X 标头（包括 Y 标头会自动包括 X 标头）。

通过“正确构造”，我的意思是，如果 Y 中的 Y1.h 中的签名依赖于（比如说）X3.h 和 X7.h，那么 Y1.h 应该包含这些文件（直接或间接）。这样，Y1.h 的任何客户端都不必知道它的依赖项是什么，并且必须单独包含这些依赖项。作为一个简单的测试，包含以下行的 .cpp 编译应该不会出现问题：

#include "Y1.h"

一个好的做法是在 Y1.cpp 中包含任何其他文件之前 #include "Y1.h"。如果 Y1.h 缺少依赖项，编译器会通知您。