【C/C++】ifndef/define/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>
······
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;
······
预处理阶段test.cpp展开头文件后变成:
/*file: test.cpp*/
/*#include <a.h> -> #include <b.h>*/
int b;
······
/*#include <b.h>*/
int b;
······
变量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>
······
编译器会报Error #include nested too deeply
的错误。
3 解决办法
以无限循环编译中的情况为例,把a.h
改写成:
#ifndef _A_H_
#define _A_H_
...
#include <b.h>
...
#endif
······
这样子为什么不会报错了呢?
在预处理阶段,会先展开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
······
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