C++ 预编译的头文件和包含的文件组织

Question

我有一个非常大的 Native C++ 项目，其中有数百个类，每个类都定义在自己的 .cpp 和 .h 文件中。这里没有什么奇怪的。我在预编译的头文件 stdafx.h 文件中声明了所有类，并且还包含在 stdafx.h 文件中，如下所示（以允许 Foo 引用 Bar 和 Bar 引用 Foo）。

这个组织是不好的做法吗？

基本上，所有类都被声明并包含在每个对象中。我假设编译器不会通过包含编译特定 .cpp 目标文件所不需要的东西来生成开销二进制文件。到目前为止，我的编译时间也没有任何问题。我只是想知道这是否是一个糟糕的代码组织。

我喜欢这种布局，因为 stdafx.h 文件本质上是一个代码映射，因为所有类都在此处声明，并且它表明嵌套命名空间是一种易于阅读的格式。这也意味着我的单个类 .h 文件不需要多个包含语句，这意味着我在更改文件名或目录时需要维护的代码更少。

stdafx.h：

#pragma once
namespace MyProject
{
    class Foo;
    class Bar;
}

#include "Foo.h"
#include "Bar.h"

foo.h:

#pragma once

namespace MyProject
{
    class Foo
    {
        // Declare class members, methods, etc
    }
}

foo.cpp:

#include "stdafx.h"

namespace MyProject
{
    class Foo
    {
        // Define class members, methods, etc
    }
}

Answer 1

在我看来，这里有 4 个关键因素：

1. 编译时间：请记住，#include "x.h" 在该行嵌入了 x.h 中的所有代码。如果项目要大幅增长，请注意您将如何影响未来的编译时间。
2. Foo 和 Bar 稳定性：如果 Foo 和 Bar 发生变化，您将不得不继续重新编译 stdafx.h
3. 循环定义：您将无法再使用前向声明来破坏循环定义。
4. 显式依赖项：您将无法查看包含内容并知道特定文件中使用了哪些内容。

如果你觉得你的优点超过了这里列出的缺点，那么你所做的事情并没有违法，那就去做吧！

Answer 2

1. 标题应该包含它需要的所有内容，不多也不少。
   这是易用性和简单封装的基本要求。

   你的例子明确地失败了这一点。

   要检测违规行为，请始终在翻译单元中首先包含相应的标头。
   如果您使用预编译的头文件，这会稍作修改，在这种情况下，必须首先包含它们。

2. 预编译的标头应该只包含很少变化的元素。

   对预编译头或其依赖项的任何更改都将强制重新编译所有内容，这与使用一个完全相反。

   你的例子也没有做到这一点。

总之，还有很多需要改进的地方。