#ifndef vs #pragma once, 哪个更好用？

相关文章系列

预处理 #pragma 命令详解-CSDN博客

目录

1.引用

2.#pragma once

3.#ifndef

4.总结

---

1.引用

        在C++编程中，头文件守卫（Header Guard）是一种防止头文件内容在同一编译单元中被多次包含的技术。这种重复包含可能导致编译错误，如类型重定义或变量多重声明。为了解决这个问题，开发者通常使用预处理指令来确保头文件只被包含一次。最常见的两种方法是使用#ifndef/#define/#endif宏（也称为传统的头文件守卫）和#pragma once指令。

2.#pragma once

        #pragma once 是一个非标准但被广泛支持的预处理符号， 其主要作用是防止文件重复引入问题，它一般由编译器保证，同一文件不会被包含多次。这里的“同一文件”是指物理上的一个文件，而不是指内容相同的两个文件。这种方式比 #ifndef 更加简洁和直观，但是它不是标准的 C++ 语法，可能不被所有编译器支持，移植型差，有些编译器支持，有些编译器不支持，比如：gcc，vs 编译器支持，bcc 编译器不支持。使用 #pragma 的方式非常简单，只需要在头文件的开头添加一行 #pragma once 即可。例如：

#pragma once

3.#ifndef

        #ifndef 是一个标准的预处理指令，它使用条件编译的方式来防止头文件被重复包含。当编译器编译到 #ifndef 指令时，它会检查这个宏是否已经被定义，如果没有被定义，则编译该文件并定义该宏。如果已被定义，则跳过该文件的编译。这种方式比较通用，可以在所有的 C++ 编译器中使用，但是需要手动定义宏，稍微有些繁琐。#ifndef 是 C 语言相关的，通过宏定义避免文件多次编译。所以在所有支持C/C++ 语言的编译器上都是有效的。跨平台移植性好。使用 #ifndef 的方式需要定义一个宏，通常使用头文件的名称作为宏的名称。例如：

#ifndef _MY_TEST_H_
#define _MY_TEST_H_

// 头文件内容

#endif // _MY_TEST_H_

        在这个例子中，_MY_TEST_H_是一个宏，如果它没有被定义，则编译头文件并定义该宏。如果已经被定义，则跳过头文件的编译。

4.总结

        #pragma once 和 #ifndef 都是用于防止头文件被重复包含的预处理指令，但它们的实现方式略有不同。下面是它们的对比：

#pragma once 依赖于编译器，可移植性较差

#pragma once 是一个非标准的预处理指令，而 #ifndef 是一个标准的预处理指令。#ifndef…#define…#endif 是 C/C++ 标准中的一部分，支持 C/C++ 的编译器都能使用，可移植性更高。

使用 #pragma once 的代码简洁

#pragma once 更加简洁和直观，但是不是标准的 C++ 语法，可能不被所有编译器支持。#ifndef 是标准的 C++ 语法，可以在所有的编译器中使用，但是需要手动定义宏。

性能区别

使用 #ifndef，编译器每次看到 #include 这个文件都需要读入文件，解析代码，效率低
而使用 #pragma once 是编译器特有指令，根本不会重复打开文件， 可以直接在编译器内部进行文件的检查，大大提高效率。

        综合上述，在选择使用#ifndef/#define/#endif宏还是#pragma once时，应该考虑项目的具体需求和目标平台。如果你的项目需要在多种编译器上工作，特别是包括一些老旧或特定的编译器，那么传统的#ifndef守卫可能是更安全的选择。然而，如果你的项目主要针对现代编译器，并且你希望代码更简洁、易维护，那么#pragma once可能是一个更好的选择。

        无论选择哪种方法，重要的是保持一致性和清晰性。确保你的项目中所有头文件都使用相同的守卫方法，并且守卫的命名清晰明了，这样可以最大限度地减少混淆和错误的可能性。