【C++】防止头文件被重复包含

代码示例

方法一：

#ifndef LEARN_AZXPLUGIN_H
#define LEARN_AZXPLUGIN_H
//开始代码部分

#endif // !LEARN_AZXPLUGIN_H

各部分的具体解释：

#ifndef LEARN_AZXPLUGIN_H

这是一个条件编译指令，用来检查 LEARN_AZXPLUGIN_H 这个宏是否已经定义过。如果没有定义过，编译器会继续向下编译直到遇到对应的 #endif。

#define LEARN_AZXPLUGIN_H

如果 LEARN_AZXPLUGIN_H 没有被定义过，这条指令就会定义它。这样做的目的是在文件的其余部分之前标记这个文件已经被包含，防止将来的重复包含。

#endif

这个指令用于结束 #ifndef 开始的条件编译块。只有 LEARN_AZXPLUGIN_H 未定义时，介于 #ifndef 和 #endif 之间的代码才会被编译器处理。

方法二：

#pragma once
//开始代码部分

这是一个非标准的预处理指令，但被多数主流编译器支持。它告诉编译器当前文件在同一编译过程中只需包含一次，起到与 #ifndef、#define 和 #endif 组合相同的效果。这样可以进一步确保头文件不会被重复包含，同时写法更简洁。

这样的头文件保护结构可以防止因头文件重复包含而导致的定义冲突或编译错误，是C++项目中常用的一个编程规范。

方法一与方法二的区别

#pragma once 和使用 #ifndef、#define、#endif组合的作用基本相同，都是为了防止头文件在同一个编译单元中被多次包含。

• #pragma once:

  是一种简洁的方式来避免多重包含（multiple inclusion）的问题。一旦头文件被包含，编译器会记住这个头文件，确保不会再次包含它，即使在复杂的包含和项目结构中也能有效工作。不是标准 C++ 的一部分，但大多数现代编译器都支持这个指令。

• #ifndef/#define/#endif:

  这是 C++ 标准中支持的方式，因此它在所有 C++ 编译器上都有效。需要为每个头文件定义一个唯一的宏名称，这样可以防止不同头文件间的宏重复。有时在非常大和复杂的项目中，开发者需要清楚哪些宏已经被定义过，以避免宏名称冲突。

虽然两者的目的相同，但在实践中可能根据项目需求、团队习惯或编译器兼容性来选择使用其中一种。#pragma once 因其简洁性和避免宏命名冲突的优点而越来越受到青睐，但在跨多个编译器或需要确保最大兼容性的环境中，传统的 #ifndef/#define/#endif 仍然非常重要。