"最常見(jiàn)"卻又"最不常用"的三個(gè)預(yù)編譯
1、情景再現(xiàn)
1
#error 與#warning
? ? 談到預(yù)編譯大家常用的有#if、#else、#ifdef、#ifndef、#endif等等條件編譯選項(xiàng)。
? ??
? ? 然而在我們閱讀一些大型的代碼或者庫(kù)的時(shí)候，一般都會(huì)看到有#error和#warning,可能有些小伙伴一掃而過(guò)并沒(méi)有了解清楚這些預(yù)編譯指令到底該怎么用，寫(xiě)了很久的代碼估計(jì)也重來(lái)沒(méi)有敲過(guò)他們。
#error / #warning
形式 :?#error / #warning?message?
作用 :?生成一個(gè)編譯錯(cuò)誤事件并停止編譯/發(fā)出警告信息
注意 :?message?可以不需要雙引號(hào)。
參考demo：
#include?
#include?
//#define?configUART_N?5
#ifndef?configUART_N
????#error?configUART_N?must?define
//?#error?"configUART?must?define"
//?#warning?"configUART?must?define"
#endif
#if?configUART_N?>?4
???#error?configUART_N?must?not?be?less?than?4
//?#error?"configUART_N?must?not?be?less?than?4"
//?#warning?"configUART_N?must?not?be?less?than?4"
#endif
/***************************************
?*?Fuction:?進(jìn)行預(yù)編譯測(cè)試?
?*?Author?:(最后一個(gè)bug)?
?**************************************/
int?main(int?argc,?char?*argv[])?{
????printf("公眾號(hào)；最后一個(gè)bug\n");
????return?0;
}
輸出結(jié)果：
編譯失敗，無(wú)法生成可執(zhí)行文件
上面是放開(kāi)宏，且使用warning的情況，無(wú)其他錯(cuò)誤的情況下可以生成可執(zhí)行文件。
解釋一下：
通過(guò)上面的測(cè)試代碼可以了解到，通過(guò)配合條件預(yù)編譯#if等，#error和#warning能夠在編譯過(guò)程中分別以錯(cuò)誤和告警的形式提醒開(kāi)發(fā)人員注意相關(guān)代碼設(shè)計(jì)問(wèn)題，從而保證代碼正確性。
這樣對(duì)于發(fā)布一些龐大的庫(kù)代碼時(shí)，為了讓開(kāi)發(fā)人員正確的使用庫(kù)，這些提示會(huì)幫助他更好的移植代碼。
那么經(jīng)常有很多小伙伴編譯出來(lái)的代碼有一大堆warning，總是覺(jué)得warning關(guān)系不大，然而warning也是分不同類(lèi)型的，對(duì)于一些未使用的變量倒關(guān)系不大，其他情況還是要認(rèn)真對(duì)待，最好是做到"0 Error，0 warning".
2
#undef
? ?#undef標(biāo)識(shí)符用于把前面的宏定義名取消，別看這宏用得不多，作用可大著呢，下面我簡(jiǎn)單舉幾個(gè)例子:
1
局部宏定義?
? ? 一旦定義了宏，那么該文件中往下所有的代碼都可以使用該宏，即使是函數(shù)內(nèi)部，這樣導(dǎo)致宏比較混亂，如下面代碼:
參考demo：
#include?
#include?
#define?configRatio?10
/***************************************
?*?Fuction:?獲得傳感器電壓值?
?*?Author?:(最后一個(gè)bug)?
?**************************************/
int?GetSensorVolt(void)
{????
#define?configRatio?1
????int?ret?=?0;
?????ret?=?configRatio*1024;?//比例因子*AD值?
????return?ret;
//#undef?configRatio
}
/***************************************
?*?Fuction:?獲得傳感器電壓值?
?*?Author?:(最后一個(gè)bug)?
?**************************************/
int?GetSensorCurr(void)
{????
#define?configRatio?2
????int?ret?=?0;
?????ret?=?configRatio*1024;?//比例因子*AD值?
????return?ret;
//#undef?configRatio
}
/***************************************
?*?Fuction:?進(jìn)行預(yù)編譯測(cè)試?
?*?Author?:(最后一個(gè)bug)?
?**************************************/
int?main(int?argc,?char?*argv[])?{
????printf("configRatio?=?%d\n",configRatio);??//報(bào)宏未定義?
????printf("GetSensorVolt?=?%d\n",GetSensorVolt());??
????printf("GetSensorCurr?=?%d\n",GetSensorCurr());?
????printf("公眾號(hào)；最后一個(gè)bug\n");
????return?0;
}輸出結(jié)果：
解釋一下：
假如我們沒(méi)有注意到函數(shù)內(nèi)部的同名宏定義，當(dāng)然告警也沒(méi)管，那么在main函數(shù)中使用同名宏定義就可能不是我們期待的最上面的宏定義，造成程序bug。
所以我們可以使用#undef來(lái)限制每個(gè)宏的作用域，如果每個(gè)函數(shù)內(nèi)部都使用了#undef，那么main函數(shù)中再使用會(huì)報(bào)宏沒(méi)有定義，這樣便可以找到問(wèn)題，當(dāng)然也可以通過(guò)警告了解到。
2
選擇接口
? ?通過(guò)宏來(lái)切換不同的接口供程序使用:
參考demo：
#include?
#include?
#include?
#define?DEV_SPI
#include?"Drive.h"
#undef?DEV_SPI
/***************************************
?*?Fuction:?進(jìn)行預(yù)編譯測(cè)試?
?*?Author?:(最后一個(gè)bug)?
?**************************************/
int?main(int?argc,?char?*argv[])?{
????char?*strbug?=?"the?last?bug"?;
????SendData(strbug);
????ProcessData(strbug);
????printf("公眾號(hào)；最后一個(gè)bug\n");
????return?0;
}
#include?
#ifdef?DEV_UART
#define?SendData(s)????printf("UART?Send:%s\n",s)
#define?ProcessData(s)??printf("UART?Process:%s\n",s)
#endif
#ifdef?DEV_CAN
#define?SendData(s)????printf("CAN?Send:%s\n",s)
#define?ProcessData(s)??printf("CAN?Process:%s\n",s)
#endif
#ifdef?DEV_SPI
#define?SendData(s)????printf("Spi?Send:%s\n",s)
#define?ProcessData(s)??printf("Spi?Process:%s\n",s)
#endif
輸出結(jié)果：
3
自定義接口
? ?當(dāng)多個(gè)人維護(hù)一套代碼的時(shí)候，有些同事喜歡調(diào)用庫(kù)函數(shù)接口，而有些同事喜歡調(diào)用自定義接口，為了方便統(tǒng)一使用自定義接口或者庫(kù)接口，我們會(huì)進(jìn)行如下操作:
參考demo：
#include?
#include?
#include?
#include?"Drive.h"
//#undef?printf
/***************************************
?*?Fuction:?進(jìn)行預(yù)編譯測(cè)試?
?*?Author?:(最后一個(gè)bug)?
?**************************************/
int?main(int?argc,?char?*argv[])?{
????char?*strbug?=?"the?last?bug"?;
????printf("公眾號(hào)；最后一個(gè)bug\n");
????return?0;
}
#ifndef?__DRIVE_H__
#define?__DRIVE_H__
#define??printf?printf("please?use?Kprintf!\n");
extern?void?Kprintf(char?*str);
#endif輸出結(jié)果：
這樣下面的代碼你就只能夠使用Kprintf來(lái)進(jìn)行輸出打印，而當(dāng)我們放開(kāi)注釋掉的宏，這樣就又可以使用printf了，還是比較方便的。
2、結(jié)束語(yǔ)
? ? 上面這幾個(gè)比較"冷門(mén)"的知識(shí)認(rèn)真想想其實(shí)還是挺有用的，可能現(xiàn)在的產(chǎn)品都急于快速上市，對(duì)于代碼的雕琢還有所欠缺的，一份成熟的代碼不僅僅只是穩(wěn)定，還有后期的維護(hù)、擴(kuò)展等等都是值得考慮的。
-END-
來(lái)源 | 最后一個(gè)bug
作者 | bug菌
|?整理文章為傳播相關(guān)技術(shù)，版權(quán)歸原作者所有?|
|?如有侵權(quán)，請(qǐng)聯(lián)系刪除?|
【1】知名半導(dǎo)體MCU大廠(chǎng)軟件開(kāi)發(fā)C代碼規(guī)范
【2】工業(yè)項(xiàng)目，用MCU還是PLC?
【3】為什么嵌入式工程師會(huì)對(duì)8位MCU有誤解？
【4】RGB 接口和 MCU 接口有什么不一樣？
【5】8位微控制器（MCU）的隱形成本
免責(zé)聲明：本文內(nèi)容由21ic獲得授權(quán)后發(fā)布，版權(quán)歸原作者所有，本平臺(tái)僅提供信息存儲(chǔ)服務(wù)。文章僅代表作者個(gè)人觀(guān)點(diǎn)，不代表本平臺(tái)立場(chǎng)，如有問(wèn)題，請(qǐng)聯(lián)系我們，謝謝！
下載文檔