现在的位置: 首页 > 技术文章 > 正文

基础篇:防止重复包含头文件

2013年11月28日 技术文章 ⁄ 共 1092字 ⁄ 字号 基础篇:防止重复包含头文件已关闭评论 ⁄ 阅读 1,749 次
头文件

头文件

假设,我们的工程中有如下三个文件 :a.h、b.h 和 c.cpp,其中 b 文件中包含了 a.h,c文件中又分别包含了 a.h 和 b.h 两个文件。在编译整个工程时,编译器会出现“multiple definition of”错误。

原因在于 a.h 文件被包含了两次。为了避免同一个文件被包含多次,C/C++ 中有两种处理方式,一种是 #ifndef方式,另一种是 #pragma once 方式。

方式 1:


#ifndef __SOMEFILE_H__

#define __SOMEFILE_H__

... ... // 声明、定义语句

#endif

方式 2:


#pragma once

... ... // 声明、定义语句

C/C++ 语言标准支持第一种方式。这种方式不仅可以保证同一个文件不会被包含多次,也能保证内容完全相同的两个文件不会被同时包含。当然,其缺点就是如果一不小心在不同头文件中定义了相同的宏名,造成了宏名“撞车” ,那就可能会导致明明看到头文件存在,编译器却硬说找不到声明,这确实会令人非常恼火。为了避免宏名“撞车” ,保证宏的唯一性,建议按照 Google 公司建议的那样,头文件基于其所在项目源代码树的全路径而命名。

命名格式为:

<PROJECT>_<PATH>_<FILE>_H_
由于编译器在每次编译时都需要打开头文件才能判定是否有重复定义,因此在编译大型项目时,ifndef 会使编译时间相对较长。

#pragma once 方式一般由编译器提供,它保证同一个文件不会被包含多次。这里所说的“同一个文件”指的是物理上的一个文件,而不是指内容相同的两个文件。#pragma once 声明只针对文件,而不能针对某一文件中的一段代码。这种方式避免了因想方设法定义一个独一无二的宏而产生的烦恼 ;另外,针对大型项目的编译速度也有了提升。但是这种方式因为不受 C/C++ 语言标准支持,所以受到了编译器的限制,它在兼容性方面表现得不是很好。此很多程序员为了代码的兼容性,宁肯降低一些编译性能,而选择遵循 C/C++ 标准,采用第一种方式。

注意 针对 #pragma once,GCC 已经取消了对其的支持,而微软的 VC++ 却仍在坚持。

请记住为了避免重复包含头文件,建议在声明每个头文件时采用“头文件卫士”加以保护,比如采用如下的形式:

#ifndef _PROJECT_PATH_FILE_H_

#define _PROJECT_PATH_FILE_H_

... ... // 声明、定义语句

#endif

×