軟件項目中引用頭文件的幾種方法及要點
本文轉載自微信公眾號「strongerHuang」,作者strongerHuang。轉載本文請聯(lián)系strongerHuang公眾號。
好的編程習慣,會直接影響代碼的質(zhì)量,在嵌入式C/C++中,頭文件的引用方式和方法有多種,同時一些細節(jié)也會影響你代碼質(zhì)量和編譯效率。
下面就來說說與頭文件有關的知識;
1.引號“”和尖括號<>
#include使用引號“” 還是 尖括號<> 這個是有規(guī)定的。
通常來說:系統(tǒng)自帶的頭文件用尖括號括起來,這樣編譯器會在系統(tǒng)文件目錄下查找。
- #include
用戶自定義的文件用雙引號括起來,編譯器首先會在用戶目錄下查找。
- #include "xxx.h"
這里可以參看我之前分享的一篇文章:#include使用引號“”和尖括號<>的區(qū)別?
2.引用頭文件路徑問題
一個項目通常有多個源文件,你要讓編譯器找到這些存儲在不同路徑下的源文件,就必須要讓編譯器知道源代碼所在(路徑)位置。
引用頭文件路徑的方式有多種,在代碼中添加路徑,在IDE工具中添加路徑,還有分絕對路徑和相對路徑。下面就來簡單說說:
1).源代碼中引用頭文件
不使用集成開發(fā)環(huán)境(IDE),通常會在源代碼中添加路徑信息,比如在源代碼文件中引用頭文件:
- #include "/strongerhuang/robot/project/bsp/bsp_uart.h"
- #include "../bsp/bsp_uart.h"
但是,你會發(fā)現(xiàn)上面那個引用有什么區(qū)別嗎?
一個是絕對路徑:
- #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++:
Keil MDK默認是相對(工程文件的)路徑。
IAR EWARM類似:
通過菜單 Project -> Options -> C/C++ Compiler:
IAR默認是絕對路徑,通常我們需要修改為相對路徑。
3.頭文件相關內(nèi)容
這里順便說下關于頭文件的幾個重要內(nèi)容。
1).防止頭文件被重復引用
這個問題對于老司機來說,可能不是什么問題,但很多新手卻沒搞明白是什么意思。
通常,在某xxx.h頭文件中,會有類似如下的一部分代碼:
- #ifndef _XXX_H
- #define _XXX_H
- #endif
“#”這是一個預處理指令,什么意思呢?
簡單來說就是:如果沒有包含XXX.h頭文件,就包含;否則不包含(即不重復引用)。
2).全局(全部)頭文件
有些工程師喜歡把一個工程中所有的.h頭文件放在一個全局的頭文件(比如 global.h)中,然后,每個.c源文件去引用這個(global.h)頭文件。
這樣有利也有弊:
利:簡單方便,不用擔心因為漏掉一個 .h 文件而引起錯誤、警告;
弊:只要修改一個.h,工程就需要全局編譯,浪費很多時間;
所以,我個人建議不使用這種全局頭文件(global.h)來管理頭文件。
這種做法只是方便了一時,也不利于管理,在幾個源文件這種小項目中可能沒覺得什么。
但是,如果項目越來越大,特別幾十上百個源代碼,每個源文件代碼又比較大的情況下,你修改一個 .h 文件,只能慢慢等待編譯。
在項目比較敢的時候,這種做法可能會使你心態(tài)奔潰。