您的位置:首页 > 其它

头文件规范——避免重复编译和重复定义

2017-08-18 11:32 120 查看

1 将声明和实现分开

  在
*.c
文件中实现,在
*.h
中声明。包括函数,自定义数据结构等。如:

*.c


#include"*.h"       //头文件应全部在对应的*.h中引入,`*.c`文件只需引入对应的`*.h`文件即可

int c[10]={0};
int Add(int a, int b)
{
return a+b;
}


*.h


#pragma once

#ifndef XXXXX
#define XXXXX

extern int c[];
int Add(int a, int b);

#endif


  如果一定要把实现放头文件则应使用如下格式:

*.c

[code]#define  CCCCC
#include"*.h"       //头文件应全部在对应的*.h中引入,`*.c`文件只需引入对应的`*.h`文件即可

extern int c[10]={0};
int Add(int a, int b)
{
return a+b;
}


*.h


#pragma once

#ifndef XXXXX
#define XXXXX

#ifndef CCCCC
extern int c[];
int Add(int a, int b);
#else
int c[10]={0};
int Add(int a, int b)
{
return a+b;
}
#endif

#endif


2 使用预编译指令

  使用预编译指令,常用的预编译指令如下:

#define        //  宏定义
#undef         //  取消宏
#include       //  文本包含
#ifdef         //  如果宏被定义就进行编译
#ifndef        //  如果宏未被定义就进行编译
#endif         //  结束编译块的控制
#if            //  表达式非零就对代码进行编译
#else          //  作为其他预处理的剩余选项进行编译
#elif          //  这是一种#else和#if的组合选项
#line          //  改变当前的行数和文件名称
#error         //  输出一个错误信息
#pragma        //  为编译程序提供非常规的控制流信息,可跟once,message等许多参数。


2.1 使用条件编译指令防止重复定义

  常用方式为:

#ifndef  XXXX
#define  XXXX
......
#include<***>
......
#endif


  优点:

不光可以保证同一个文件不被包含多次,也能保证内容完全相同的两个文件(或者代码片段)不被同时包含。

受C/C++语言标准的支持,不受编译器的任何限制

  缺点:

如果不同头文件中的宏名不小心“撞车”,可能就会导致你看到头文件明明存在,编译器却硬说找不到声明的状况——这种情况有时非常让人抓狂。

由于编译器每次都需要打开头文件才能判定是否有重复定义,因此在编译大型项目时,ifndef会使得编译时间相对较长,因此一些编译器逐渐开始支持#pragma once的方式。

2.2 pragma once指令防止重复编译

  同一个文件不会被包含多次。注意这里所说的“同一个文件”是指物理上的一个文件,而不是指内容相同的两个文件。你无法对一个头文件中的一段代码作pragma once声明,而只能针对文件。

  优点:

你不必再费劲想个宏名了,当然也就不会出现宏名碰撞引发的奇怪问题。

大型项目的编译速度也因此提高了一些。

  缺点:

就是如果某个头文件有多份拷贝,本方法不能保证他们不被重复包含。当然,相比宏名碰撞引发的“找不到声明”的问题,这种重复包含很容易被发现并修正。

而#pragma once方式却不受一些较老版本的编译器支持,一些支持了的编译器又打算去掉它,所以它的兼容性可能不够好。

2.3 两者混用

  两者混用可以节约一定的间,比如多次引入同一“物理意义上的”头文件,就可以不用展重复引入开头文件。

#pragma once

#ifndef XXXX #define XXXX ...... #include<***> ...... #endif
内容来自用户分享和网络整理,不保证内容的准确性,如有侵权内容,可联系管理员处理 点击这里给我发消息
标签: