C++实践小经验——#include 何时放在头文件里，何时放在cpp文件里？

结合我自己的经验，谈一谈模块化编程时#include应该出现的位置。总结起来大体有二条规则：

一、规则1：只包含必要的头文件

　　看下面这个模块：

===foo.c====
#include <stdio.h>
#include <foo.h>
#include <uart.h>void foo ()
{printf ("hello world!\n");
}

===foo.h====
#ifndef __foo_h__
#define __foo_h__extern void foo();#endif

在foo()函数中也只有简单的一行打印语句。由于printf()函数的原型声明来源于stdio.h，因此foo.c中包含了stdio.h无可厚非，否则根本无法使用。但foo.c文件中除了包含stdio.h外还包含了另外一个多余的头文件 ——uart.h，这不会导致编译的出错，但我们并不需要使用uart.h中声明的接口，因此这种行为会导致编译效率的降低。如果此时uart.h中还包含了其它文件，那么全部都会在预处理时展开到foo.c中。当一个项目的代码量很大时，由于效率地下而多占用的时间就无法忽视了。

二、规则2：使#include出现在它被需要的地方

为了使用printf()函数，可以把#include<stdio.h>放在foo.h文件中，编译也可以正常通过，如下：

===foo.h====
#ifndef __foo_h__
#define __foo_h__#include <stdio.h>extern void foo();#endif

===foo.c====#include <foo.h>void foo ()
{printf ("hello world!\n");
}

但这样会产生一个问题，stdio.h对于我们的头文件foo.h来说，是必须的么？当然不是！那么会导致什么样的问题呢？我们已经直到.h文件的作用相当于模块的使用说明书，如果其它模块要使用foo模块时，需要通过#include<foo.h>来添加接口函数，此时就会间接的包含了stdio.h，同样的会导编译致速度下降的问题。因此，正确的做法是将#include<stdio.h>放在foo.c中，如下：

===foo.h====
#ifndef __foo_h__
#define __foo_h__extern void foo();#endif===foo.c====
#include <stdio.h>
#include <foo.h>void foo ()
{printf ("hello world!\n");
}

理解了上面的例子，则看下面一条实例：

在system.h中，定义了如下结构体定义：

=====system.h=====#ifndef __system_h__
#def __system_h__typedef struct stuTAG{char * name;u8       age;}stu_st;#endif

同样在一个foo.c模块中，定义了一个函数：

===foo.h====
#ifndef __foo_h__
#define __foo_h__
#include "system.h"extern void print_info(stu_st * student);#endif

=====foo.c=====
#include "foo.h"
#include <stdio.h>void print_info(stu_st * student)
{printf("name:%s\n",student->name);  printf("age :%d\n",student->age);    }

从这个foo模块的实现代码来看，foo.h和foo.c都需要了解stu_st结构体的内容，也就是stu_st是被foo.c和foo.h同时需要的，因此它必须被放置在foo.h中，否则编译时会出现stu_st未定义的错误，此时将#include放置在.h文件中是必须的！

用一句话概括：只在必要的地方包含必要的头文件！

C++实践小经验——#include 何时放在头文件里，何时放在cpp文件里？相关推荐

C++中头文件（.h）和源文件（.cpp）都应该写些什么，头文件中的预编译语句作用，命名空间和头文件的区别与联系，内部链接和外部链接
1. C++中头文件(.h)和源文件(.cpp)都应该写些什么: 总结下来就是头文件写的就是类的声明(包括类里面的成员和方法的声明)和函数的声明,但一般来说不写出具体的实现.对应的同名(可以不同名,但 ...
include.cpp（main函数的cpp文件）文件中包含另一个.cpp文件的错误及原因
当一个main函数的cpp文件包含另一个cpp文件,使用#include "data.cpp" 是不可以的,例如下面 include.cpp #include <stdio ...
Hi-Fi小经验(转)
Hi-Fi小经验(转) 1.如果你的音箱脚架使用螺钉固定的,不妨在在螺丝上套上一层"生料带",这样螺丝与铸铁(或者铝板)之间的结合更紧密,脚架将会更加结实,稳固: 2.购买皮带,皮 ...
数据治理方法论和实践小百科全书
什么是数据治理? 数据治理是指从使用零散数据变为使用统一数据.从具有很少或没有组织流程到企业范围内的综合数据管控.从数据混乱状况到数据井井有条的一个过程. 从范围来讲,数据治理涵盖了从前端业务系统.后 ...
c语言工程实践小超市商品管理系统
小超市商品管理系统 • 使用文件.链表,系统以菜单方式工作. • 某商店每天有进货.售货.统计销售额.计算毛利率.查看商品剩余量等业务.设计一个菜单,实现下述功能 • 创建商品档案.每一个商品信息包括 ...
单体架构迁移到微服务，8个关键的思考、实践和经验
单体架构迁移到微服务,8个关键的思考.实践和经验转自:http://www.open-open.com/lib/view/open1470917801705.html 随着微服务架构的持续火热,网络 ...
网站前端优化一些小经验
/** *作者:张荣华 *日期:2008-12-01 **/ 乘着第3届d2论坛的顺利结束的秋风,我也来分享一下自己在前端优化方面的一些些小经验,其实这些经验本身都是来自yahoo的优 ...
使用HTML语言编写HTML教程,HTML教程:HTML编写小经验
在用HTML(HyperText Markup Language,超文本链接标示语言)语言编写Web页面时,由于所用的Web浏览器对HTML支持的程度不同,常常会在HTML语言的运用上产生一些疑问.在 ...
将类的定义放在头文件中，把成员函数的实现代码放在一个cpp文件中
将类的定义放在头文件中,把成员函数的实现代码放在一个cpp文件中写这种.h和.cpp文件分开的大程序,虽然对很多人来说很简单,对自己来说算是第一次吧,好好学C++,加油~ 题目:定义Point类,由 ...

C++实践小经验——#include 何时放在头文件里，何时放在cpp文件里？

C++实践小经验——#include 何时放在头文件里，何时放在cpp文件里？相关推荐

最新文章

热门文章