事情是這樣的，有人離職，公司調(diào)我補(bǔ)缺。那個(gè)系統(tǒng)一直有個(gè)工程師在維護(hù)，參與該系統(tǒng)的新人來(lái)了又走，他始終泰然自若。剛過(guò)去一個(gè)禮拜，我就心下竊吼：“坑爹??！”，也徹底體會(huì)到什么叫---絕對(duì)的權(quán)威、專家。該軟件系統(tǒng)，是公司發(fā)家的支柱產(chǎn)品，涉及十幾個(gè)國(guó)家x七八個(gè)機(jī)型，700+個(gè)文件（C語(yǔ)言，所有.c .h檔），十幾萬(wàn)行代碼，盡兩百個(gè)跨模塊全局變量，編譯條件成百上千。..。..（好吧，這是找借口、吐槽的節(jié)奏）。 盡管有名義上的交接，和幾次和聲細(xì)語(yǔ)的密切指導(dǎo)。但真正獨(dú)立展開(kāi)工作時(shí)，許多小功能增刪改，我都要折騰個(gè)好幾天才能厘清代碼調(diào)用關(guān)系、算法原理，然后找到修改點(diǎn)謹(jǐn)慎細(xì)微龜速前行。 進(jìn)度追蹤的人有的時(shí)候也催毛了，直接請(qǐng)專家大師出手，咔咔咔，不到半天就搞定了。

當(dāng)然，前期我當(dāng)然盡量的”不恥上問(wèn)”，但人嘛，總是有遇到被激發(fā)“骨氣”的時(shí)候。 這幾天，好不容易搞好一個(gè)全新的功能模塊，把代碼推送給他合并編譯。不曾想，出現(xiàn)了讓我泣血的一幕。 我眼睜睜地、眼睜睜看著她把我辛苦敲入的代碼注釋/**/通通換成//，一份精美的代碼，頓時(shí)成渣。 我詢問(wèn)緣由，她的回答是： 當(dāng)代碼里面充滿注釋符號(hào)/**/時(shí)，她想要用/**/注釋整段代碼時(shí)，就會(huì)很麻煩。 我理解了，因?yàn)?**/不支持嵌套。比如下面這樣的語(yǔ)句是編譯不過(guò)的。

/*

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

*/

我的手抬了抬，終究作罷。雖然我感覺(jué)到尊嚴(yán)被踐踏，心愛(ài)的作品被蹂躪，但我還是開(kāi)始反思。 許多軟件規(guī)范、專家、有經(jīng)驗(yàn)的工程，都建議或要求注釋代碼最好使用/**/，他們的理由大略如下：

1 “//”進(jìn)行注釋不夠嚴(yán)謹(jǐn)

例如：

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

a = b+c;

此時(shí)，a = b+c在一些編譯器不會(huì)被執(zhí)行。 因?yàn)椤埃浚?”會(huì)被編譯器當(dāng)作 ，變成C語(yǔ)言的換行符。于是這段代碼等同于// 注釋語(yǔ)句 a = b+c ;就會(huì)被注釋掉。大家有興趣的，不妨去搜索一下“C語(yǔ)言 三字母詞” 當(dāng)然，哪怕沒(méi)有？？/， 自己打盹碰到delete鍵也是會(huì)屏蔽掉a=b+c的。

2 “//”的注釋來(lái)源于C++

有些早期的C編譯器對(duì)這種注釋是不支持的。代碼要做到全平臺(tái)兼容，這點(diǎn)是必須要考慮的。 因此，老外定義的C語(yǔ)言軟件規(guī)范，無(wú)論是MISRA還是CMMI，一般都要求所有代碼注釋必須使用/**/。 君不見(jiàn)，那uCOS的最新版本源碼，所有注釋都是/**/。 君不見(jiàn)，那STM32的最新固件庫(kù)，洋洋灑灑幾十個(gè)文件，通篇皆沒(méi)有用到//。 正是基于這樣的理由，讓我的心中充滿了慍怒。但我仍然沒(méi)有當(dāng)場(chǎng)反駁她，因?yàn)檫@些理由還有些蒼白無(wú)力。 當(dāng)時(shí)，那個(gè)什么三字母詞“？？x”到底是什么我已經(jīng)忘了，沒(méi)法立刻做試驗(yàn)編譯給她看，而且時(shí)候我里面做了編譯實(shí)驗(yàn)，得到的是： “filename.c”， line xxxx： Warning： #2532-D： support for trigraphs is disabled xx代碼語(yǔ)句xx // ？？/ trigraph金山詞霸---》 ［traigra:f］三字母詞，看吧，編譯器都警告了，默認(rèn)是不支持的。 而且，所謂的//是C++的，早期的c編譯器不支持。 這點(diǎn)誰(shuí)鳥(niǎo)啊，我們只要現(xiàn)在，只用最新版本的編譯器，所以，我還要繼續(xù)思考，我要維護(hù)這個(gè)傳統(tǒng)，為自己代言。..。.. 我開(kāi)始思考，還有什么強(qiáng)勁有力的理由，來(lái)支持我恪守的真理：C語(yǔ)言代碼注釋必須使用/**/。

3 我的三大理解

倘若所有代碼里面的注釋用到/**/時(shí)，當(dāng)你要注釋掉這段代碼時(shí)，如果不想忍受編譯器的嵌套報(bào)警，又懶得把一個(gè)個(gè)/**/換成//的話。那么你還有如下選擇。 1） 慎重思考下是否刪光這段代碼，如果還有些不舍，那就先“備份”（git推送）一下再刪光。因此， 理由一：使用/**/注釋代碼，會(huì)使軟件系統(tǒng)減少冗余的僵尸代碼，鼓勵(lì)程序員的程序備份行為。 2） 或者用編譯條件圈起來(lái)，如下。

#if （XXX_ENABLE）

func（a， b， c）; /* 注釋 */

。..。.. /* 注釋 */

#endif

那么你不得不考慮xxx的命名，如何更加一目了然，再寫(xiě)點(diǎn)注釋什么的，表明對(duì)這段代碼“棄而不舍”的緣由。因此， 理由二：使用/**/注釋代碼，會(huì)鼓勵(lì)程序員刪除代碼時(shí)，三思而后行，并且注明舍棄的理由。 3） 當(dāng)然，偷懶的人還是會(huì)用 #if 0 #endif圈起來(lái)， 如下，

#if 0

func（a， b， c）; /* 注釋 */

。..。.. /* 注釋 */

#endif

而且不會(huì)寫(xiě)任何注釋表明刪除的理由。然而，“#if 0”是一個(gè)如此的醒目，很容易成為一個(gè)評(píng)估軟件質(zhì)量、工作績(jī)效的搜索關(guān)鍵詞。從管理的角度，這個(gè)是可以量化的。因此， 理由三： 使用/**/注釋代碼，有利于公司進(jìn)行軟件質(zhì)量控管，對(duì)程序員績(jī)效考核。 這三個(gè)理由，足夠說(shuō)服你么？

編輯：黃飛