当一个项目比较大时,往往都是分文件,这时候有可能不小心把同一个头文件 包含多次,或者头文件嵌套包含,比如:
a.h 代码如下:
#include "b.h"
b.h 代码如下:
#include "a.h"
main.c 代码如下:
#include "a.h"
int main()
{
return 0;
}
编译上面的例子,会出现如下错误:
为了避免同一个文件被包含多次,C/C++中有两种方式,一种是 #ifndef 方式,一种是 #pragma once 方式。在能够支持这两种方式的编译器上,二者并没有太大的区别,但是两者仍然还是有一些细微的区别。
方式一:
#ifndef __FILENAME_H__
#define __FILENAME_H__
/* Variable or function declare */
#endif
方式二:
#pragma once
/* Variable or function declare */
#ifndef 的方式受 C/C++ 语言标准支持。它不光可以保证同一个文件不会被包含多次,也能保证内容完全相同的两个文件(或者代码片段)不会被不小心同时包含。
当然,缺点就是如果不同头文件中的宏名不小心“撞车”,可能就会导致你看到头文件明明存在,编译器却硬说找不到声明的状况——这种情况有时非常让人抓狂,情况如下:
a.h 文件 #ifndef 中的宏为 A_H
#ifndef __A_H__
#define __A_H__
#include "b.h"
#endif
b.h 文件 #ifndef 中的宏同样为 A_H
#ifndef __A_H__
#define __A_H__
#include "a.h"
#endif
结果编译同样错误,而且项目大了后,错误还不容易发现。
由于编译器每次都需要打开头文件才能判定是否有重复定义,因此在编译大型项目时,ifndef会使得编译时间相对较长,因此一些编译器逐渐开始支持#pragma once的方式。
#pragma once 一般由编译器提供保证:同一个文件不会被包含多次。注意这里所说的“同一个文件”是指物理上的一个文件,而不是指内容相同的两个文件。你无法对一个头文件中的一段代码作pragma once声明,而只能针对文件。 其好处是,你不必再费劲想个宏名了,当然也就不会出现宏名碰撞引发的奇怪问题。大型项目的编译速度也因此提高了一些。
对应的缺点就是如果某个头文件有多份拷贝,本方法不能保证他们不被重复包含。当然,相比宏名碰撞引发的“找不到声明”的问题,这种重复包含很容易被发现并修正。
#ifndef受C/C++语言标准的支持,不受编译器的任何限制;而#pragma once方式却不受一些较老版本的编译器支持,一些支持了的编译器又打算去掉它,所以它的兼容性可能不够好。
还看到一种用法是把两者放在一起的:
#pragma once
#ifndef __SOMEFILE_H__
#define __SOMEFILE_H__
/* Variable or function declare */
#endif
看起来似乎是想兼有两者的优点。不过只要使用了#ifndef就会有宏名冲突的危险,也无法避免不支持#pragma once的编译器报错,所以混用两种方法似乎不能带来更多的好处,倒是会让一些不熟悉的人感到困惑。
原文出处:这里写链接内容