2

我正在创建一个只有头文件的 C++11/14 库，但我不确定应该如何处理#include库文件之间的指令。

我应该尝试#include在面向用户的模块头文件中对尽可能多的指令进行分组，还是内部文件应该包含它们需要的文件（有时重复相同的包含）？

方法一：

在这种方法中，模块头文件包含所有必需的依赖项，然后包含实现。实现的头文件本身不包含任何内容。

// Library/Module/Module.hpp
// This file is intended to be included by the user in his projects.

#ifndef MODULE
#define MODULE

#include <vector>
#include "Library/Module/Impl/SharedDependency.hpp"
#include "Library/Module/Impl/Class1.hpp"
#include "Library/Module/Impl/Class2.hpp"

#endif MODULE

-

// Library/Module/Impl/SharedDependency.hpp

#ifndef SHARED_DEPENDENCY
#define SHARED_DEPENDENCY

inline void sharedFunc() { }

#endif

-

// Library/Module/Impl/Class1.hpp

#ifndef CLASS1
#define CLASS1

// No need to include "SharedDependency.hpp", as it will be included by
// the module header file. Same applies for <vector>.
struct Class1 
{ 
    std::vector<int> v;        
    Class1() { sharedFunc(); } 
};

#endif

-

// Library/Module/Impl/Class2.hpp

#ifndef CLASS2
#define CLASS2

// No need to include "SharedDependency.hpp", as it will be included by
// the module header file. Same applies for <vector>.
struct Class2
{ 
    std::vector<int> v;        
    Class2() { sharedFunc(); } 
};

#endif

方法 B：

在这种方法中，模块头文件仅包含实现头文件。如果实现头文件需要额外的包含，它们会（递归地）包含文件本身，有时会重复相同的包含。

// Library/Module/Module.hpp
// This file is intended to be included by the user in his projects.

#ifndef MODULE
#define MODULE

#include "Library/Module/Impl/Class1.hpp"
#include "Library/Module/Impl/Class2.hpp"

#endif MODULE

-

// Library/Module/Impl/SharedDependency.hpp

#ifndef SHARED_DEPENDENCY
#define SHARED_DEPENDENCY

inline void sharedFunc() { }

#endif

-

// Library/Module/Impl/Class1.hpp

#ifndef CLASS1
#define CLASS1

#include <vector>
#include "Library/Module/Impl/SharedDependency.hpp"

struct Class1
{ 
    std::vector<int> v;        
    Class1() { sharedFunc(); } 
};

#endif

-

// Library/Module/Impl/Class2.hpp

#ifndef CLASS2
#define CLASS2

#include <vector>
#include "Library/Module/Impl/SharedDependency.hpp"

struct Class2
{ 
    std::vector<int> v;        
    Class2() { sharedFunc(); } 
};

#endif

最好的方法是什么？

直觉上，我认为方法 A是最好的，因为它避免重复相同的包含，并明确需要在其他文件之前包含哪些文件。但是，最大的缺点是语法高亮在我的 IDE ( QT-Creator ) 中停止工作，在没有包含指令的实现文件中。

编辑：

由于“基于意见”的原因，该问题被投票关闭。我不同意，因为在像我的包含文件的库这样的大型仅标头项目中，可能需要大量编译时间。因此，方法 A 可能比方法 B 更快，或者相反。

4

1 回答 1

0

方法 B实际上是最好的方法，因为多次包含相同的标头不会产生任何可观察到的编译时间增加，但由于以下原因是有利的：

  • 现代 IDE 可以使用libclang或专有解决方案来解析#include指令并提供代码感知语法突出显示和自动完成功能。

  • 正如 TemplateRex 所提到的，验证一个健全的构建过程变得更加容易。例如，CMake 提供了自动为每个标头生成测试的宏。

  • 正如 Alf 所提到的，让每个文件都包含它所依赖的所有头文件是一种很好的做法——然后库的用户可以“挑选”他们需要的头文件，而不是意外地强制手动包含父头文件。

于 2016-01-07T00:52:47.977 回答