一線(xiàn)研發(fā)之聲 之 C代碼注釋引發(fā)的“血案”

　　我要無(wú)辜的坦白說(shuō)，您遇到標題黨了。

　　沒(méi)有血案，但有些沖突。不是代碼bug，我要講注釋風(fēng)格。

　　這位看官，既然來(lái)了，且讀且評吧。故事是真實(shí)的，如有雷同純屬巧合。

　　事情是這樣的，有人離職，公司調我補缺。那個(gè)系統一直有個(gè)工程師在維護，參與該系統的新人來(lái)了又走，他始終泰若磐石。剛過(guò)去一個(gè)禮拜，我就心下竊吼：“TMD坑爹啊!”，也徹底體會(huì )到什么叫---絕對的權威、專(zhuān)家。該軟件系統，是公司發(fā)家的支柱產(chǎn)品，涉及十幾個(gè)國家x七八個(gè)機型，700+個(gè)文件(C語(yǔ)言，所有.c .h檔)，十幾萬(wàn)行代碼，盡兩百個(gè)跨模塊全局變量，編譯條件成百上千......(好吧，這是找借口、吐槽的節奏)

　　盡管有名義上的交接，和幾次和聲細語(yǔ)的密切指導。但真正獨立展開(kāi)工作時(shí)，許多小功能增刪改，我都要折騰個(gè)好幾天才能厘清代碼調用關(guān)系、算法原理，然后找到修改點(diǎn)謹慎細微龜速前行。進(jìn)度追蹤的人有的時(shí)候也催毛了，直接請專(zhuān)家大師出手，咔咔咔，不到半天就搞定了。當然，前期我當然盡量的”不恥上問(wèn)”，但人嗎，總是有遇到被激發(fā)“骨氣”的時(shí)候。

　　這幾天，好不容易搞好一個(gè)全新的功能模塊，把代碼推送給他合并編譯。不曾想，出現了讓我泣血的一幕。

　　我眼睜睜地、眼睜睜看著(zhù)她把我辛苦敲入的代碼注釋/**/通通換成//，一份精美的代碼，頓時(shí)成渣。

　　我詢(xún)問(wèn)緣由，她的回答是: 當代碼里面充滿(mǎn)注釋符號/**/時(shí)，她想要用/**/注釋整段代碼時(shí)，就會(huì )很麻煩。 我理解了，因為/**/不支持嵌套。比如下面這樣的語(yǔ)句是編譯不過(guò)的。

　　/*

　　a = b+c; /* 注釋 */

　　*/

　　我的手抬了抬，終究作罷。雖然我感覺(jué)到尊嚴被踐踏，心愛(ài)的作品被蹂躪，但我還是開(kāi)始反思。

　　許多軟件規范、專(zhuān)家、有經(jīng)驗的工程，都建議或要求注釋代碼最好使用 /**/，他們的理由大略如下:

　　1. “//” 的注釋的嚴密性不夠。 例如

　　// 注釋語(yǔ)句 ??/

　　a = b+c;

　　此時(shí)，a = b+c在一些編譯器不會(huì )被執行。

　　因為"??/"會(huì )被編譯器當作 ，變成C語(yǔ)言的換行符。于是這段代碼等同于

　　// 注釋語(yǔ)句 a = b+c ;

　　就會(huì )被注釋掉。大家有興趣的，不妨去搜索一下"C語(yǔ)言 三字母詞"

　　當然，哪怕沒(méi)有??/， 自己打盹碰到delete鍵也是會(huì )屏蔽掉a=b+c的

　　2. “//” 的注釋?zhuān)荂++發(fā)展后才引進(jìn)的。 有些早期的C編譯器對這種注釋是不支持的。代碼要做到全平臺兼容，這點(diǎn)是必需要考慮的。

　　因此，老外定義的C語(yǔ)言軟件規范，無(wú)論是MISRA還是CMMI，一般都要求所有代碼注釋必須使用/**/。

　　君不見(jiàn)，那uCOS的最新版本源碼，所有注釋都是/**/。

　　君不見(jiàn)，那STM32的最新固件庫，洋洋灑灑幾十個(gè)文件，通篇皆沒(méi)有用到//。

　　正是基于這樣的理由，讓我的心中充滿(mǎn)了慍怒。但我仍然沒(méi)有當場(chǎng)反駁她，因為這些理由還有些蒼白無(wú)力。

　　1. 當時(shí)，那個(gè)什么三字母詞“??x”到底是什么我已經(jīng)忘了，沒(méi)法立刻做試驗編譯給她看。

　　而且時(shí)候我里面作了編譯實(shí)驗，得到的是

　　"filename.c", line xxxx: Warning: #2532-D: support for trigraphs is disabled xx代碼語(yǔ)句xx // ??/

　　trigraph金山詞霸---> [traigra:f]三字母詞

　　看吧，編譯器都警告了，默認是不支持的。

　　2. 而且，所謂的//是C++的，早期的c編譯器不支持。

　　這點(diǎn)誰(shuí)鳥(niǎo)啊，我們只要現在，只用最新版本的編譯器。

　　所以，我還要繼續思考。

　　我要維護這個(gè)傳統，為自己代言......