软件项目中引用头文件的几种方法及要点

﹏ヽ暗。殇╰゛Y 2022-11-05 14:59 105阅读 0赞

**关注+****星标公众****号**，不错过精彩内容

![bd6d42c6e5d387a2a0d48d376c03ca6a.gif][]

作者 | strongerHuang

微信公众号 | 嵌入式专栏

好的编程习惯，会直接影响代码的质量，在嵌入式C/C++中，头文件的引用方式和方法有多种，同时一些细节也会影响你代码质量和编译效率。

下面就来说说与头文件有关的知识；

嵌入式专栏

**引号“”和尖括号<>**

\#include使用引号“” 还是 尖括号<> 这个是有规定的。

通常来说：**系统自带的头文件用尖括号括起来，这样编译器会在系统文件目录下查找**。

#include <xxx.h>

**用户自定义**的文件用双引号括起来，编译器首先会在用户目录下查找。

#include "xxx.h"

这里可以参看我之前分享的一篇文[**章：\#include使用引号“”和尖括号<>的区别？**][include]

嵌入式专栏

**引用头文件路径问题**

一个项目通常有多个源文件，你要让编译器找到这些存储在不同路径下的源文件，就必须要让编译器知道源代码所在（路径）位置。

**引用头文件路径的方式有多种，在代码中添加路径，在IDE工具中添加路径，还有分绝对路径和相对路径。下面就来简单说说：**

**1.源代码中引用头文件**

不使用集成开发环境（IDE），通常会在源代码中添加路径信息，比如在源代码文件中引用头文件：

#include "/strongerhuang/robot/project/bsp/bsp_uart.h"
    #include "../bsp/bsp_uart.h"

但是，你会发现上面那个引用有什么区别吗？

一个是绝对路径：

#include "/strongerhuang/robot/project/bsp/bsp_uart.h"

一个是相对路径：

#include "../bsp/bsp_uart.h"

**2.IDE工具中引用头文件**

我们使用的Keil、IAR这种工具，可以不用像上面那样，在源代码中添加路径头文件，只需要在工程中配置编译路径即可。

**比如Keil MDK：**

通过菜单 Project -> Options for Taget -> C/C++：

![0fdffa67e015d33521314e74ab7d9b1d.png][]

Keil MDK默认是相对（工程文件的）路径。

这里推荐扩展阅读（工程选项配置）相关的文章：

**[Keil系列教程05\_工程目标选项配置（一）][Keil_05]**

**[Keil系列教程06\_工程目标选项配置（二）][Keil_06]**

**IAR EWARM类似：**

通过菜单 Project -> Options -> C/C++ Compiler：

![fa466eb037722aa3ce28e78e985c7d20.png][]

IAR默认是绝对路径，通常我们需要修改为相对路径。

这里推荐扩展阅读（工程选项配置）相关的文章：

**[IAR系列教程06\_工程节点选项配置（一）][IAR_06]**

**[IAR系列教程07\_工程节点选项配置（二）][IAR_07]**

嵌入式专栏

**头文件相关内容**

这里顺便说下关于头文件的几个重要内容。

**1.防止头文件被重复引用**

这个问题对于老司机来说，可能不是什么问题，但很多新手却没搞明白是什么意思。

通常，在某xxx.h头文件中，会有类似如下的一部分代码：

#ifndef _XXX_H
    #define _XXX_H
    
    
    #endif

“\#”这是一个预处理指令，什么意思呢？

简单来说就是：**如果没有包含XXX.h头文件，就包含；否则不包含（即不重复引用）**。

**2.全局（全部）头文件**

有些工程师喜欢把一个工程中所有的.h头文件放在一个全局的头文件（比如 global.h）中，然后，每个.c源文件去引用这个（global.h）头文件。

这样有利也有弊：

**利：**简单方便，不用担心因为漏掉一个 .h 文件而引起错误、警告；

**弊：**只要修改一个.h，工程就需要全局编译，浪费很多时间；

**所以，我个人建议不使用这种全局头文件（global.h）来管理头文件。**

这种做法只是方便了一时，也不利于管理，在几个源文件这种小项目中可能没觉得什么。

但是，如果项目越来越大，特别几十上百个源代码，每个源文件代码又比较大的情况下，你修改一个 .h 文件，只能慢慢等待编译。

在项目比较敢的时候，这种做法可能会使你心态奔溃。

\------------ **END** ------------

后台回复『**嵌入式C语言**』『**嵌入式软件基础知识**』阅读更多相关文章。

**欢迎关注我的公众号，**回复“**加群**”按规则加入技术交流群，回复“**1024**”查看更多内容。

**欢迎关注我的视频号：**

![3853ee27e424d281f2e66a9019a72c84.png][]

点击“**阅读原文**”查看更多分享，欢迎**点分享、收藏、点赞、在看。 **

[bd6d42c6e5d387a2a0d48d376c03ca6a.gif]: /images/20221023/c33fa882f55d4b8f933b1b2942ec8783.png
[include]: https://mp.weixin.qq.com/s?__biz=MzUxNjgxMDE4OQ%3D%3D&idx=1&mid=2247484808&scene=21&sn=3e24e80c31916f7d58c46c81ef17f25f#wechat_redirect
[0fdffa67e015d33521314e74ab7d9b1d.png]: /images/20221023/408d196b3dd44f52af7fe63125669073.png
[Keil_05]: http://mp.weixin.qq.com/s?__biz=MzUxNjgxMDE4OQ%3D%3D&chksm=f9a0f670ced77f66036723de8bbf0720a278b02e882339404b76f1ae4fedcc1175f9c127e111&idx=1&mid=2247484114&scene=21&sn=784642e26965a0f4d13ce7b6a625707e#wechat_redirect
[Keil_06]: http://mp.weixin.qq.com/s?__biz=MzUxNjgxMDE4OQ%3D%3D&chksm=f9a0f67cced77f6a0cc59805e213f979bd180b143c9a0de1ed2414b38d53e13d8c9b3708f5e9&idx=1&mid=2247484126&scene=21&sn=dfed6416f0d322b2a91f6543bfb937fe#wechat_redirect
[fa466eb037722aa3ce28e78e985c7d20.png]: /images/20221023/738da40c9de943d195ed37b45f504c9a.png
[IAR_06]: http://mp.weixin.qq.com/s?__biz=MzUxNjgxMDE4OQ%3D%3D&chksm=f9a0f517ced77c0120beb0217ac578c0d86ee9ed85c931ffc19ea949c9ba0f47748ff99dd769&idx=1&mid=2247483829&scene=21&sn=7e871a6223c186571517f37e71c8e52c#wechat_redirect
[IAR_07]: http://mp.weixin.qq.com/s?__biz=MzUxNjgxMDE4OQ%3D%3D&chksm=f9a0f566ced77c70ef18605e14c2e5608d7da560c5d264a749e17ef1d12416fee9501b1e61ce&idx=1&mid=2247483844&scene=21&sn=1e3421694619a5e50a10420475d89a40#wechat_redirect
[3853ee27e424d281f2e66a9019a72c84.png]: /images/20221023/dcbcbd82fa8748d2b7cf65caf4a06c34.png