我应该按照什么顺序包含头文件？

Question

我是编程新手，在我开始使用大量头文件后，头文件的主题让我陷入了困境。除此之外，我正在尝试使用预编译头。我还使用 SFML 库，因此我还必须包含那些标头。

现在我有 stdafx.h、main.cpp，然后是 Ah、A.cpp、Bh、B.cpp、Ch、C.cpp、Dh 和 D.cpp 中包含的类 A、B、C 和 D。

我将按什么顺序在所有文件中包含标头

• 如果所有类都包含 SFML 类的实例
• ，类 D 包含类 A 的实例，类 C
• 包含类 B 的实例， 我的代码：（注意：所有标头都有标头保护）

stdafx.h：

#include <SFML/Graphics.hpp>
#include <iostream>

Ah

#include "stdafx.h"
class A
{
    //sfml class
};

A.cpp

#include "stdafx.h"
#include "A.h"

B.h

#include "stdafx.h"
class B
{
    //sfml class
};

B.cpp

#include "stdafx.h"
#include "B.h"

C.h

#include "B.h"
class C: public B
{

};

C.cpp

#include "stdafx.h"
#include "C.h"

D.h

#include "A.h"
#include "C.h"
class D
{
    A a;
    C C; // if left uncommented I recieve a '1 unresolved externals' error
    //sfml class
}

D.cpp

#include "stdafx.h"
#include "D.h"

main.cpp

#include "stdafx.h"
#include "D.h"

Answer 1

我的理念是，在编写良好的代码中，头文件应该包含它们所依赖的所有其他头文件。我的理由是，不应该包含头文件并因此而出现编译器错误。因此，每个头文件应该（在 #ifdef 或 #pragma Once 之后 包含防护）包含它所依赖的所有其他标头。

为了非正式地测试您是否记得在头文件中包含正确的头文件，*.cpp 文件应该 #include 应该起作用的最小头文件集。因此，如果 A、B、C 和 D 有单独的头文件，并且您的 cpp 文件使用类D，那么它应该只包含Dh。不应产生编译器错误，因为 Dh #include 为 Ah 和 Ch、Ch > 包括 Bh，Ah 和 Bh 包括 SFML 标头（无论是什么）。如果合适的话，Ch 和 Dh 可以包含 SFML 标头，但如果您可以确定依赖项 (Bh和啊）已经包含了它。

然而，Visual C++ 的“预编译头”方式搞砸了这个逻辑。它要求您将“StdAfx.h”包含为第一个头文件，这导致许多开发人员简单地将所有#include放在整个项目都放在 StdAfx.h 中，并且不要在任何其他头文件中使用 #include。我不推荐这个。或者，他们会将所有外部依赖项放在 StdAfx.h 中（例如 windows.h、boost 标头）并在其他地方#include 本地依赖项，以便更改单个头文件不一定会导致整个项目重建。

按照我编写代码的方式，我的大多数 CPP 文件都包含 StdAfx.h 和相应的 .H 文件。因此，A.cpp 包括 StdAfx.h 和 Ah，B.cpp 包括 StdAfx.h 和 Bh，依此类推。 cpp 文件中放置的唯一其他 #include 是头文件未公开的“内部”依赖项。例如，如果类 A 调用 printf()，则 A.cpp（不是 Ah）将#include，因为 Ah 不依赖于 stdio.h。

如果您遵循这些规则，那么您的#include标头并不重要（除非您使用预编译标头：那么预编译标头在每个 cpp 文件中排在第一位，但不会不需要从头文件中包含）。

Answer 2

查看类似的问题学习创作标题的好方法。

简而言之，您希望在定义防护内定义每个标头，以防止在编译期间多次包含标头。完成这些后，对于每个 .h 和 .cpp 文件，只需包含解析任何声明所需的标头即可。预处理器和编译器将处理剩下的事情。

Answer 3

C继承类B。因此，它应该看到标识符 B。因此，在此处包含 Bh -

#include "B.h"    // Newly added
// Or you can forward declare class B ; 
class C: public B
{

};

D 具有类 A、B 的对象。因此，在“Dh”本身中包含 A, B 标头。

class D
{
    A a;  // Should see the definition of class A
    C c;  // Should see the definition of class B
    //sfml class
}

D.cpp

#include "A.h"
#include "C.h"
#include "D.h"  // Notice that A.h and C.h should definitely placed before

请注意，每个标头都需要包含在其相应的源文件中。独立地考虑每个源文件，看看所使用的内容是否是先前在源文件中定义的。

Answer 4

Ah 应包含 SFML

A.cpp 应包含 Ah

Dh 应包含 SFML、Ah 和 Ch

D.cpp 应包含 Dh

main.cpp 应包含它直接使用的 A、B、C、D 和 SFML 中的任何一个。

通常，在 .cpp 文件中，我不包含任何您知道必须包含在其相应 .h 中的标头，因为它们包含该 .h 中定义的类的数据成员的定义。因此，在我的代码中 D.cpp 不会包含 Ah That's just me，不过，您可能更愿意包含它，只是为了提醒您 .cpp 文件（大概）使用它。

这留下了 stdafx - 你需要它的地方取决于它里面的东西的用途。可能到处都需要它，并且 MSVC 不会处理（或处理但丢弃？）源文件中 #include "stdafx.h" 之前的任何内容，因此它应该是每个 .cpp 中的第一件事文件并出现在其他地方。

所有头文件都应该具有多重包含保护。

您可以将 SFML（或您喜欢的任何其他内容）添加到 stdafx.h，在这种情况下，您也可以从其他地方删除这些包含内容。

完成此操作后，在每个文件中包含标头的顺序不再重要。所以你可以做你喜欢做的事，但我推荐 Google 的 C++ 风格指南主题（单击箭头事物），调整以适应 stdafx.h。

Answer 5

取决于依赖关系。与 C# 和其他类似语言不同，C++ 按照编写的顺序执行操作，因此可能存在问题。如果您的顺序确实有问题，那么它将无法编译。