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