聊聊代碼的保養

作者：嵌入式系統 2020-11-23 07:00:38

開發前端

不只女人要保養，代碼也是如此。面向對象編程，就是把面對的代碼當作對象一樣，定期對其進行保養。

[[353521]]

不只女人要保養，代碼也是如此。面向對象編程，就是把面對的代碼當作對象一樣，定期對其進行保養。

一、美顏 Astyle+Source Insight

二、祛痘 cppCheck

三、返老還童 git

四、工欲善其事必先利其器

一、美顏 Astyle+Source Insight

1.1真假小龍女的問題

都說秀色可餐，同樣的角色，都是小龍女，但是效果不一樣。

[[353522]]

實現同樣的功能，有的代碼一目了然，像詩一樣賞心悅目;有的卻像SHI一樣，如下面的代碼，雖然功能正常，但看起來什么感覺?

//C語言混亂大賽作品 
#include <stdio.h> 
main(int t,int _,char* a) 
{ 
    return !0<t?t<3?main(-79,-13,a+main(-87,1-_,  
main(-86,0,a+1)+a)):1,t<_?main(t+1,_,a):3,main(-94,-27+t,a)&&t==2?_<13?  
main(2,_+1,"%s %d %d\n"):9:16:t<0?t<-72?main(_,t,  
"@n'+,#'/*{}w+/w#cdnr/+,{}r/*de}+,/*{*+,/w{%+,/w#q#n+,/#{l+,/n{n+,/+#n+,/#;#q#n+,/+k#;*+,/'r :'d*'3,}{w+K w'K:'+}e#';dq#'l q#'+d'K#!/+k#;q#'r}eKK#}w'r}eKK{nl]'/#;#q#n'){)#}w'){){nl]'/+#n';d}rw' i;# ){nl]!/n{n#'; r{#w'r nc{nl]'/#{l,+'K {rw' iK{;[{nl]'/w#q#n'wk nw' iwk{KK{nl]!/w{%'l##w#' i; :{nl]'/*{q#'ld;r'}{nlwb!/*de}'c ;;{nl'-{}rw]'/+,}##'*}#nc,',#nw]'/+kd'+e}+;#'rdq#w! nr'/ ') }+}{rl#'{n' ')# }'+}##(!!/")  
:t<-50?_==*a?putchar(a[31]):main(-65,_,a+1):main((*a=='/')+t,_,a+1)  
:0<t?main(2,2,"%s"):*a=='/'||main(0,main(-61,*a,  
"!ek;dc i@bK'(q)-[w]*%n+r3#l,{}:\nuwloca-O;m .vpbks,fxntdCeghiry"),a+1); 
}

正如女人愛美一樣，出門必化妝，拍照必美顏;代碼也是需要美顏妝扮，除非你期望后來接手者在心中的十萬個詛咒，這TM誰寫的?尤其對嵌入式系統產品，升級維護周期長，軟件的可讀性就顯得更加重要;代碼規范對后續維護升級是大有裨益的。

1.2 代碼格式化

一般公司不缺編碼規范，缺的是執行。小項目單人完成，編碼風格隨心所欲;大項目團隊完成，編碼風格各不相同。目前來說，個人只發現go語言是編譯時強制格式化，其他語言編譯時，不檢查排版格式。對于編碼規范，不能依靠個人主觀，強推工具自動實現才能提高執行力。

不管編碼使用Keil/MDK、Qt等集成工具，或者純粹的代碼編輯工具Source Insight，一般都支持自定義運行可執行文件，如Astyle。可以客制化新菜單，一鍵執行Astyle，將代碼一鍵格式化，排版統一、層次分明。

Astyle官網 http://astyle.sourceforge.net/ 按要求下載安裝，只需要AStyle.exe即可。關于其使用和參數，可以在進入Documentation。對代碼基本風格，{}如何對齊、是否換行，switch-case如何排版，tab鍵占位寬度，運算符或變量前后的空格等等，基本上代碼排版涉及的方方面面都有參數說明。個人選擇的編碼參數是

--style=allman -S -U -t -n -K -p -s4 -j -q -Y -xW -xV fileName

效果如下

int Foo(bool isBar) 
{ 
    if (isBar) 
    { 
        bar(); 
        return 1; 
    } 
    else 
    { 
        return 0; 
    } 
}

建議先參考文檔逐個熟悉作用，確認參數，然后集成到編輯工具，以Source Insight為例。

1、在選項或者工具下(不同Source Insight版本不同)打開“自定義命令”，添加命令和運行。

2、選擇正確的路徑，結合前面的參數類型，最后必須加上 %f，表示對該文件執行，

C:\AStyle.exe --style=allman -S -U -t -n -K -p -s4 -j -q -Y -xW -xV  %f

3、將該命令插入到編輯菜單，后續在編輯欄點擊Astyle，即可對當前文件自動進行格式化排版。

1.3 高級配置

前面只是Source Insight的基礎擴展，下面簡要說明下高級擴展宏功能，本文只是描述下基本流程。1、配置菜單

2、插入之后，在主菜單欄會出現“工作”的菜單,點擊Insertifdef，彈出如下對話框

3、確定之后自動在光標處插入代碼

#if defined (ABCD) 
 
#endif /* ABCD */

4、不止是支持插入if defined ,還包括插入文件頭，對h文件插入避免多次包含的宏，對函數插入注釋，以及自動添加編輯時間、作者名稱等。這些宏配置和前面一樣，至于客制化，比如函數注釋的內容、格式等，也是可以自由定義。5、配置路徑如下

先關閉全部Source Insight工程，再打開Base.PR，編輯utils.em。如前面的宏 Insertifdef就是如下的代碼

macro InsertIfdef() 
{ 
 sz = Ask("Enter ifdef condition:") 
 if (sz != "") 
  IfdefSz(sz); 
} 
 
// Wrap ifdef <sz> .. endif around the current selection 
macro IfdefSz(sz) 
{ 
 hwnd = GetCurrentWnd() 
 lnFirst = GetWndSelLnFirst(hwnd) 
 lnLast = GetWndSelLnLast(hwnd) 
   
 hbuf = GetCurrentBuf() 
 InsBufLine(hbuf, lnFirst, "#if defined (@sz@)") 
 InsBufLine(hbuf, lnLast+2, "#endif /* @sz@ */") 
}

如Ask就是彈出提示語，sz獲取輸入的內容，再InsBufLine插入兩行代碼。而這些接口的使用說明，只要打開Source Insight的幫助即可查看。

Ask說明：

例如插入函數注釋的代碼如下：

szInf = Ask("你為什么要編寫這個函數:") 
szDescription = Ask("請輸入函數的使用注意事項和算法實現:")  
// begin assembling the title string 
sz = "/******************************************************************************" 
InsBufLine(hbuf, ln, sz) 
InsBufLine(hbuf, ln + 1, " *  Function    -  @szFunc@") 
InsBufLine(hbuf, ln + 2, " * ") 
InsBufLine(hbuf, ln + 3, " *  Purpose     -  @szInf@") 
InsBufLine(hbuf, ln + 4, " * ")  
InsBufLine(hbuf, ln + 5, " *  Description -  @szDescription@") 
InsBufLine(hbuf, ln + 6, " * ") 
InsBufLine(hbuf, ln + 7, " * modification history") 
InsBufLine(hbuf, ln + 8, " * ----------------------------------------") 
InsBufLine(hbuf, ln + 9, " * v1.0  , @szDay@-@szMonth@-@Year@,  @szMyName@  written") 
InsBufLine(hbuf, ln + 10, " * ----------------------------------------") 
InsBufLine(hbuf, ln + 11, " ******************************************************************************/")

最終自動插入的函數注釋顯示效果如下：

/****************************************************************************** 
 *  Function    -  [myFunction] 
 * 
 *  Purpose     - 
 * 
 *  Description -  [函數的功能] 
 * 
 *  modification history 
 * ---------------------------------------- 
 * v1.0  , 22-11-2020,  embedded-system  written   [時間格式可自由設定] 
 * ---------------------------------------- 
*******************************************************************************/

6、其他宏也是這樣，可以自由配置，當然，開啟這個功能的第一步是先編輯，替換全部szMyName為自己的名字。有一點需要注意的是插入函數注釋時，光標必須在該函數第一個{內，否則無法獲取函數名，會提示錯誤。

1.4 總結

Source Insight集成Astyle自動排版，統一風格;集成宏定義，統一注釋格式、提高效率。

二、祛痘 cppCheck

2.1 祛痘除隱患

依靠美顏可以掩蓋面部瑕疵，如痘痘，但為了極致，應該從根源祛痘，素顏就美，淡妝濃抹總相宜。代碼規范整齊，還要沒有隱患，大部分開發人員都對警告視而不見，覺得隱患沒啥大問題，

[[353523]]

同樣的美女，若是一臉痘痘，顏值瞬間下降。代碼也是如此，編譯警告如同痘痘，看起來不礙事，實際對代碼的質量和后期維護都是隱患，要培養習慣，凡是警告都要消滅的習慣。

另外對于編碼規范，不只是排版布局，還有命名規范，例如宏定義使用小寫字母，就必須指出要求修改。所以，代碼必須經過祛痘，除去小隱患，嚴苛的要求，造就趨于完美的代碼。但是，依靠人工檢查效率低下，靜態掃描順便檢查命名規范的神器應運而生。

代碼的靜態檢測工具有很多，為什么推薦cppCheck?因為它是Qt實現且開源。作為嵌入式軟件開發，Qt可以錦上添花，它本身可以多平臺運行，平時使用它開發小工具，模擬驗證部分代碼，比起在真機編譯下載調試快捷方便。

cppCheck官網http://cppcheck.net/，可以下載執行文件和源碼，稍微有Qt基礎的，可以下載源碼，其Qt工程如下，可以根據自身要求和能力，進行二次開發。

實現代碼自動格式化和靜態分析，可以有效規避軟件風險。基于開源的Cppcheck，集成Astyle，結合實際開發平臺和編碼標準，使用Qt集成的codeCheck誕生了。

codeCheck執行的流程，先將C語言代碼自動格式化，按指定的規則排版對齊，調整代碼間空格和間距，特殊語句強制換行或添加括號等，簡單操作即可完成代碼格式統一化(也就是上一章的配置參數)。然后拆分代碼字符，建立token數據庫，按預置的規則分析代碼是否存在匹配的非法代碼，并直觀顯示風險代碼位置以便跟蹤修復。codeCheck不具備編譯語法分析，因此導入的文件必先確保編譯正常，再進行分析才有意義。

針對實際開發中的問題點，比如變量命名沖突，或者關鍵變量缺少注釋導致維護升級困難，特別增加了個性化掃描標準。由于個人時間和水平有限，工具還存在優化改進的必要，但基本可滿足常規應用和新人培養。

即使沒有Qt基礎，直接使用開源版本，也是相當給力的，二次開發只是錦上添花而已。

2.2 代碼掃描與靜態分析

個人二次開發后的主界面如下，和原始的cppcheck差不多，只是多了命名規范檢查(全局變量必須g_開頭，帶注釋;宏定義、枚舉值禁止包含小寫字母等)。

“分析”導入文件或文件夾后，即可啟動自動格式化并分析代碼邏輯，顯示結果如下：

選擇“分析結果”欄，則顯示掃描出的風險代碼，標明風險類型和代碼位置，具體顯示如下圖。

2.3 源碼分析

非cppcheck源碼，二次開發的代碼片段。

void CheckThread::run()  //運行掃描，這里是入口 
{ 
 /**/ 
    QString file = mResult.getNextFile(); 
    while (!file.isEmpty() && mState == Running)  
    { 
        qDebug() << "format file" << file; 
        file_format(file);//添加Astyle命令 
        mCppcheck.check(file.toStdString()); 
     /**/ 
     } 
     /**/

//astyle.exe v3.1  添加代碼格式化 
void CheckThread::file_format(const QString file) 
{ 
    QProcess builder; 
    QStringList param; 
 
    param<<"--style=allman"<<"-S"<<"-U"<<"-t"<<"-n"<<"-K"<<"-p"<<"-s4"<<"-j"<<"-q"\ 
        <<"-Y"<<"-xW"<<"-xV"<<file; 
 
    if(file.endsWith(".c",Qt::CaseSensitive)||file.endsWith(".cpp",Qt::CaseSensitive)\ 
       ||file.endsWith(".h",Qt::CaseSensitive)) 
    { 
        builder.start("codeFormat.exe",param); 
        builder.waitForFinished(); 
    } 
}