#pragma once vs include guards?

我正在开发一个已知只能在windows上运行并在Visual Studio下编译的代码库(它与excel紧密集成，所以它不会消失)。我想知道我是否应该使用传统的包含守卫或使用#pragma一次为我们的代码。我认为让编译器处理一次#pragma会产生更快的编译，并且在复制和粘贴时更不容易出错。它也稍微不那么丑陋;)

注意:为了获得更快的编译时间，我们可以使用冗余包含守卫，但这增加了包含文件和包含文件之间的紧密耦合。通常这是可以的，因为守卫应该基于文件名，并且只在你需要改变包含名称时才会改变。

当前回答

从软件测试人员的角度来看

#pragma once比include守卫更短，更不容易出错，被大多数编译器支持，有人说它编译更快(这不是真的[不再])。

但我仍然建议你使用标准的#ifndef include守卫。

为什么ifndef ?

考虑这样一个人为的类层次结构，其中每个类a、B和C都存在于自己的文件中:

a.h

#ifndef A_H
#define A_H

class A {
public:
  // some virtual functions
};

#endif

b.h

#ifndef B_H
#define B_H

#include "a.h"

class B : public A {
public:
  // some functions
};

#endif

c.h

#ifndef C_H
#define C_H

#include "b.h"

class C : public B {
public:
  // some functions
};

#endif

现在让我们假设您正在为您的类编写测试，并且您需要模拟非常复杂的类b的行为。实现这一点的一种方法是使用例如谷歌mock编写一个模拟类，并将其放在目录mocks/b.h中。注意，类名没有改变，但它只存储在不同的目录中。但最重要的是，包含守护的名称与原始文件b.h中的名称完全相同。

mocks / b.h

#ifndef B_H
#define B_H

#include "a.h"
#include "gmock/gmock.h"

class B : public A {
public:
  // some mocks functions
  MOCK_METHOD0(SomeMethod, void());
};

#endif

有什么好处?

使用这种方法，您可以模拟类B的行为，而不涉及原始类或告诉C。您所要做的就是将目录mocks/放在编译器的include路径中。

为什么不能用#pragma一次性完成?

如果你只使用了一次#pragma，你就会得到一个名称冲突，因为它不能防止你定义类B两次，一次是原始版本，一次是模拟版本。

2014-11-13 11:38:26

其他回答

我回答了一个相关的问题:

#pragma once确实有一个缺点(除了不是标准的)，那就是如果你在不同的位置有相同的文件(我们有这样的情况是因为我们的构建系统会四处复制文件)，那么编译器会认为这些是不同的文件。

我把答案也加在这里，以防有人被这个问题绊倒，而不是其他问题。

2015-10-15 07:38:07

直到#pragma成为标准的那一天(这不是未来标准的优先级)，我建议你使用它并使用守卫，这样:

#ifndef BLAH_H
#define BLAH_H
#pragma once

// ...

#endif

原因如下:

#pragma once is not standard, so it is possible that some compiler don't provide the functionality. That said, all major compiler supports it. If a compiler don't know it, at least it will be ignored. As there is no standard behavior for #pragma once, you shouldn't assume that the behavior will be the same on all compiler. The guards will ensure at least that the basic assumption is the same for all compilers that at least implement the needed preprocessor instructions for guards. On most compilers, #pragma once will speed up compilation (of one cpp) because the compiler will not reopen the file containing this instruction. So having it in a file might help, or not, depending on the compiler. I heard g++ can do the same optimization when guards are detected but it have to be confirmed.

同时使用这两种编译器，可以充分利用每种编译器的优点。

现在，如果您没有一些自动脚本来生成守卫，那么只使用#pragma一次可能会更方便。要知道这对可移植代码意味着什么。(我使用VAssistX生成守卫和pragma一次快速)

你应该总是认为你的代码是可移植的(因为你不知道未来是由什么组成的)，但如果你真的认为它不应该用另一个编译器编译(例如非常特定的嵌入式硬件的代码)，那么你应该检查一下编译器文档中关于#pragma的内容，以了解你真正在做什么。

2009-07-17 15:45:00

我只是想补充一下这个讨论，我只是在VS和GCC上编译，并且习惯使用包含守卫。我现在已经切换到#pragma一次了，对我来说唯一的原因不是性能或可移植性或标准，因为我并不关心什么是标准，只要VS和GCC支持它，那就是:

#pragma一次性减少了出现错误的可能性。

将一个头文件复制并粘贴到另一个头文件，修改它以满足自己的需要，并且忘记更改include守卫的名称，这太容易了。一旦包含了两者，就需要花费一些时间来跟踪错误，因为错误消息并不一定是清晰的。

2011-07-22 16:55:17

#pragma曾经有无法修复的错误。它不应该被使用。

如果你的#include搜索路径足够复杂，编译器可能无法区分两个具有相同基底名的头文件(例如a/foo.h和b/foo.h)，因此在其中一个头文件中使用#pragma一次将同时屏蔽两个头文件。它也可能无法区分两个不同的相对include(例如#include "foo.h"和#include "../a/foo.h"指的是同一个文件，因此#pragma once将无法在应该包含冗余include的情况下抑制冗余include。

这也会影响编译器避免使用#ifndef守卫重读文件的能力，但这只是一种优化。使用#ifndef守卫，编译器可以安全地读取它不确定已经看过的任何文件;如果是错的，它只需要做一些额外的工作。只要没有两个头文件定义相同的保护宏，代码将按预期编译。如果两个头文件定义了相同的保护宏，程序员可以进去修改其中一个。

#pragma曾经没有这样的安全网——如果编译器对头文件的标识错误，无论哪种情况，程序都将编译失败。如果你遇到了这个错误，你唯一的选择是停止使用#pragma一次，或者重命名一个头文件。头文件的名称是API契约的一部分，因此重命名可能不是一个选项。

(简而言之，这是不可修复的，因为Unix和Windows文件系统API都没有提供任何机制来保证告诉你两个绝对路径名是否指向同一个文件。如果您认为inode编号可以用于此，那么对不起，您错了。)

(历史注:12年前，当我有权从GCC中删除#pragma和#import时，我没有这样做的唯一原因是苹果的系统头文件依赖于它们。现在回想起来，这不应该阻止我。)

(因为这个问题已经在评论中出现了两次:GCC开发人员确实花了很多精力让#pragma once尽可能可靠;参见GCC bug报告11569。然而，GCC当前版本中的实现仍然可能在合理的条件下失败，例如构建农场受到时钟倾斜的影响。我不知道其他编译器的实现是什么样的，但我不期望任何人做得更好。)

2016-01-19 18:52:11