c++ - 清理你的#include 语句？

Question

如何在 C 或 C++ 项目中维护#include 语句？似乎几乎不可避免的是，文件中的包含语句集最终要么不足(但由于项目的当前状态而恰好可以工作)或包含不再需要的内容。

您是否创建了任何工具来发现或纠正问题？有什么建议吗？

我一直在考虑编写一些东西，多次单独编译每个非头文件，每次都删除#include 语句。继续这样做，直到获得最少的包含集。

为了验证头文件是否包含他们需要的所有内容，我将创建一个源文件，它所做的只是包含一个头文件并尝试编译它。如果编译失败，则头文件本身缺少包含。

在我创造一些东西之前，我想我应该在这里问一下。这似乎是一个有点普遍的问题。

Answer 1

To verify that header files are including everything they need, I would creating a source file that all it does is include a header file and try to compile it. If the compile fails, then the header file itself is missing an include.

你可以通过以下规则获得相同的效果:foo.c 或 foo.cpp 必须包含的第一个头文件应该是相应命名的 < em>foo.h。这样做可以确保 foo.h 包含它需要编译的任何内容。

此外，Lakos 的Large-Scale C++ Software Design 一书(例如)列出了许多将实现细节从 header 移出并移入相应 CPP 文件的技术。如果您将其发挥到极致，使用 Cheshire Cat(隐藏所有实现细节)和 Factory(隐藏子类的存在)之类的技术，那么许多 header 将能够在不包含其他 header 的情况下独立存在，而只需将声明转发到不透明类型...可能除了模板类。

最后，每个头文件可能需要包含:

• 对于属于数据成员的类型没有头文件(相反，使用“柴郡猫”又名“pimpl”技术在 CPP 文件中定义/隐藏数据成员)

• 对于作为方法参数或从方法返回类型的类型没有头文件(相反，这些类型是预定义类型，如 int ；或者，如果它们是用户定义的类型，那么它们是其中的引用在这种情况下，前向声明的、不透明的类型声明(如仅在头文件中的 class Foo; 而不是 #include "foo.h" 就足够了)。

那么你需要的是头文件:

• 父类(super class)，如果这是子类

• 可能是任何用作方法参数和/或返回类型的模板化类型:显然你也应该能够前向声明模板类，但某些编译器实现可能对此有问题(尽管您还可以封装任何模板，例如 List<X> 作为用户定义类型的实现细节，例如 ListX )。

在实践中，我可能会创建一个“standard.h”，其中包含任何/所有使用的所有系统文件(例如 STL 头文件、O/S 特定类型和/或任何 #define s 等​​)项目中的头文件，并将其作为第一个头文件包含在每个应用程序头文件中(并告诉编译器将此“standard.h”视为“预编译头文件”)。

---

//contents of foo.h
#ifndef INC_FOO_H //or #pragma once
#define INC_FOO_H

#include "standard.h"
class Foo
{
public: //methods
  ... Foo-specific methods here ...
private: //data
  struct Impl;
  Impl* m_impl;
};
#endif//INC_FOO_H

---

//contents of foo.cpp
#include "foo.h"
#include "bar.h"
Foo::Foo()
{
  m_impl = new Impl();
}
struct Foo::Impl
{
  Bar m_bar;
  ... etc ...
};
... etc ...