防止C语言头文件被重复包含 — ifndef & #pragma once

参考：extern的使用详解

问题：头文件被重复引用—变量多次定义错误

问题：头文件被重复引用

就是重复引入同一个头文件，重复引入同一头文件有什么问题呢，当你在头文件中定义变量或者函数时（注意是定义不是声明，多次声明是没有问题的）多次引入头文件就会报“变量被多次定义”的错误

---

• 举例：3个头文件k1.h、k2.h、my.h在k1.h和k2.h中都包含了my.h，而且在my.h中有一个全局变量int k = 10，在test1.c中包含了上述三个头文件

//my.h
extern int Max(int num1,int num2);
int k=10; 

//k1.h
//模拟头文件重复定义
#include "my.h"

//k2.h
//模拟头文件重复定义
#include "my.h"

//test.cpp
#include<stdio.h>
#include "my.h"
#include "k1.h"
#include "k2.h"

int main(){
    int a;

    a=Max(15,20);
    printf("%d\n",a);
    return 0;
}

编译结果：

• 当你在头文件中定义变量或者函数时（注意是定义不是声明，多次声明是没有问题的）多次引入头文件就会报“变量被多次定义”的错误
• 也就是说.h中有变量时候，多次定义会多次初始化导致错误
• 注意是定义不是声明，多次声明是没有问题的）多次引入头文件就会报 “变量被多次定义” 的错误

---

 

下面讲解下解决方案：

1. 解决方法一：使用ifndef防止重复定义

如果需要查看预处理命令的见预处理命令使用详解----#if、#endif、#undef、#ifdef、#else、#elif

解决上面那个问题可以在my.h中修改变量的定义：

extern int Max(int num1,int num2);
//int k=10;

//解决方法：ifnedf防止重复定义
#ifndef _MY_H
#define _MY_H
int k=10;  //这样就防止这个变量重复引用并初始化
#endif

解释一下上面的条件编译语句，如果_MY_H这个宏名没有被定义，那么定义_MY_H这个宏名，并且定义全局变量int k = 10，这样做就避免了头文件的重复包含引起的，变量或函数的重复定义问题

---

我们可以在stdio.h这个“标准输入\输出头文件”中看到类似的用法

格式如下：

格式就像下面这个样子：

#ifndef _INC_STDIO  //_INC_STDIO是stdio.h的名称，也就是防止重复引用的头文件名称
#define _INC_STDIO
/* 头文件内容 */
#endif

---

 

ifndef缺点— 宏名同名，无法查找正确

这种宏保护方案使得程序员可以“任性”地引入当前模块需要的所有头文件，不用操心这些头文件中是否包含了其他的头文件

但也不是没有缺点

#ifndef的方式依赖于宏名不能冲突，这不光可以保证同一个文件不会被包含多次，也能保证内容完全相同的两个文件不会被不小心同时包含

缺点就是如果不同头文件的宏名不小心“撞车”，可能就会导致头文件明明存在，编译器却硬说找不到声明的状况

• 意思就是ifndef后面的宏名同名，导致找不到声明的状态，使得编译器无法正确处理头文件的包含关系。

解决：通常建议在宏名前面加上一个前缀，例如"_MY_H"这样的形式。

---

 

2. 解决方法二：使用#pragma once防止多次定义

如果你想写跨平台的代码，最好使用条件编译,如果想使用#pragma once，

只需在头文件开头加上#pragma once即可

//解决方法二：使用#pragma once
#pragma once

extern int Max(int num1,int num2);
int k=10;

#pragma带来的好处是：你不必再费劲想个宏名了，当然也就不会出现宏名碰撞引发的奇怪问题;

缺点：无法保证多份拷贝重复包含

坏处也有，#pragma once是由编译器提供保证：同一个文件不会被包含多次。注意这里所说的“同一个文件”是指物理上的一个文件，而不是指内容相同的两个文件，如果某个头文件有多份拷贝，这个方法就不能保证他们不被重复包含。当然，相比宏名碰撞引发的“找不到声明”的问题，重复包含更容易被发现并修正

---

 

总结：

1. #ifndef 由语言支持所以移植性好
2. #pragma 可以避免名字冲突