#ifndef/#define/#endif使用详解

https://blog.csdn.net/abc5382334/article/details/18052757

    想必很多人都看过“头文件中的 #ifndef/#define/#endif 防止该头文件被重复引用”。但是是否能理解“被重复引用”是什么意思？是不能在不同的两个文件中使用include来包含这个头文件吗？如果头文件被重复引用了，会产生什么后果？是不是所有的头文件中都要加入#ifndef/#define/#endif 这些代码？

    其实“被重复引用”是指一个头文件在同一个cpp文件中被include了多次，这种错误常常是由于include嵌套造成的。比如：存在a.h文件#include "c.h"而此时b.cpp文件导入了#include "a.h" 和#include "c.h"此时就会造成c.h重复引用。

头文件被重复引用引起的后果：

有些头文件重复引用只是增加了编译工作的工作量，不会引起太大的问题，仅仅是编译效率低一些，但是对于大工程而言编译效率低下那将是一件多么痛苦的事情。
有些头文件重复包含，会引起错误，比如在头文件中定义了全局变量(虽然这种方式不被推荐，但确实是C规范允许的)这种会引起重复定义。

    是不是所有的头文件中都要加入#ifndef/#define/#endif 这些代码？

    答案：不是一定要加，但是不管怎样，用#ifnde xxx #define xxx #endif或者其他方式避免头文件重复包含，只有好处没有坏处。个人觉得培养一个好的编程习惯是学习编程的一个重要分支。

    下面给一个#ifndef/#define/#endif的格式：

    #ifndef A_H意思是"if not define a.h"  如果不存在a.h

    接着的语句应该#define A_H  就引入a.h

    最后一句应该写#endif   否则不需要引入

--------------------------------------------------------------------------------------------------
#ifndef GRAPHICS_H // 防止graphics.h被重复引用 
#define GRAPHICS_H 


#include <math.h> // 引用标准库的头文件 
… 
#include “header.h” // 引用非标准库的头文件 
… 
void Function1(…); // 全局函数声明 
… 
class Box // 类结构声明 
{ 
… 
}; 
#endif
--------------------------------------------------------------------------------------------------

参考资料来源于网上，还未经本人实验证明。

1 作用

  防止头文件被重复包含和编译。 头文件重复包含会增大程序大小，重复编译增加编译时间。

  解释：#ifndef起到的效果是防止一个源文件多次包含同一个头文件。那么一个源文件为什么会两次包含同一个头文件呢？
  你写的test.cpp里包含了a.h和b.h，a.h里包含了b.h，所以b.h就会被包含和编译两次。

/*file: test.cpp*/
#include <a.h>
#include <b.h>
······
/*file: a.h*/
#include <b.h>
······

  
  

  
  
7

2 缺失ifndef的风险

1、重复定义：
如果b.h中定义了一个变量b，在编译test.cpp时就会报重复定义的错误。

/*file: test.cpp*/
#include <a.h>
#include <b.h>
······
/*file: a.h*/
#include <b.h>

/file: b.h/
int b;
······

• 10

预处理阶段test.cpp展开头文件后变成：

/*file: test.cpp*/
/*#include <a.h> -> #include <b.h>*/ 
int b;
······
/*#include <b.h>*/
int b;
······

 
 

 
 
7

变量b重复定义。

2、无限循环编译：
你写的test.cpp里包含了a.h和b.h，a.h里包含了b.h，b.h里包含了a.h，所以a.h，b.h就会循环包含，预处理阶段就会不停地循环展开头文件。

/*file: test.cpp*/
#include <a.h>
#include <b.h>
······
/*file: a.h*/
#include <b.h>
······
/*file: b.h*/
#include <a.h>
······

 
 

 
 
10

编译器会报Error #include nested too deeply的错误。

3 解决办法

以无限循环编译中的情况为例，把a.h改写成：

#ifndef _A_H_
#define _A_H_
...
#include <b.h>	
...
#endif
······

 
 

 
 
7

这样子为什么不会报错了呢？
  在预处理阶段，会先展开test.cpp中的头文件a.h，执行到#ifndef _A_H_，发现此时并没有_A_H_并没有被define，所以继续执行#define _A_H_，此时_A_H_就被define了；当展开b.h，执行到文件里的#include <a.h>，进入a.h执行#ifndef _A_H_，发现_A_H_已经被define了，所以直接跳到a.h里endif之后的语句执行。这样子就可以保证a.h不会被重复包含。如果要确保b.h不会被重复包含就该写成：

#ifndef _B_H_
#define _B_H_
...
#include <a.h>
...
#endif
······

 
 

 
 
7

4 建议

  所有头文件前后都加上ifndef/define/endif。

5 reference

1、主要目的：https://zhidao.baidu.com/question/22559696.html 如下图所示。

2、隐藏危险-重复定义：https://www.jb51.net/article/100939.htm
3、隐藏危险-无限循环编译：https://blog.csdn.net/weixin_41656968/article/details/80493923

在头文件里面加入以下代码（文件名是test.h），可以防止头文件被重复引用，而导致编译出错。
//文件开头写下面两行
#ifndef __TEST_H
#define __TEST_H   //一般是文件名的大写
...........                     //代码段

//文件结尾写下面一行
#endif

下面这种引用也是可以的，但常见的是上面这种

#ifndef TEST_H_INCLUDED
#define TEST_H_INCLUDED   //一般是文件名的大写
...........                                      //代码段

//文件结尾写下面一行
#endif

在类的头文件定义里面，第一句话就是#pragma once，它的作用和上面的代码所起的作用是一样的，都是防止重复引用

以下引用——原文：https://blog.csdn.net/abc5382334/article/details/18052757 

想必很多人都看过“头文件中的 #ifndef/#define/#endif 防止该头文件被重复引用”。但是是否能理解“被重复引用”是什么意思？是不能在不同的两个文件中使用include来包含这个头文件吗？如果头文件被重复引用了，会产生什么后果？是不是所有的头文件中都要加入#ifndef/#define/#endif 这些代码？

    其实“被重复引用”是指一个头文件在同一个cpp文件中被include了多次，这种错误常常是由于include嵌套造成的。比如：存在a.h文件#include "c.h"而此时b.cpp文件导入了#include "a.h" 和#include "c.h"此时就会造成c.h重复引用。

头文件被重复引用引起的后果：

有些头文件重复引用只是增加了编译工作的工作量，不会引起太大的问题，仅仅是编译效率低一些，但是对于大工程而言编译效率低下那将是一件多么痛苦的事情。
有些头文件重复包含，会引起错误，比如在头文件中定义了全局变量(虽然这种方式不被推荐，但确实是C规范允许的)这种会引起重复定义。

    是不是所有的头文件中都要加入#ifndef/#define/#endif 这些代码？

    答案：不是一定要加，但是不管怎样，用#ifnde xxx #define xxx #endif或者其他方式避免头文件重复包含，只有好处没有坏处。个人觉得培养一个好的编程习惯是学习编程的一个重要分支。

    下面给一个#ifndef/#define/#endif的格式：

    #ifndef A_H意思是"if not define a.h"  如果不存在a.h

    接着的语句应该#define A_H  就引入a.h

    最后一句应该写#endif   否则不需要引入