C語言代碼注釋必須用/**/ , 你沒看錯~
[導(dǎo)讀]來源于網(wǎng)絡(luò)沒有血案，但有些沖突。不是代碼bug，我要講注釋風(fēng)格。這位看官，既然來了，且讀且評吧。故事是真實的，如有雷同純屬巧合。故事是真實的，如有雷同純屬巧合。事情是這樣的，有人離職，公司調(diào)我補(bǔ)缺。那個系統(tǒng)一直有個工程師在維護(hù)，參與該系統(tǒng)的新人來了又走，他始終泰然自若。剛過去一個...
來源于網(wǎng)絡(luò)
沒有血案，但有些沖突。不是代碼bug，我要講注釋風(fēng)格。
這位看官，既然來了，且讀且評吧。故事是真實的，如有雷同純屬巧合。故事是真實的，如有雷同純屬巧合。事情是這樣的，有人離職，公司調(diào)我補(bǔ)缺。那個系統(tǒng)一直有個工程師在維護(hù)，參與該系統(tǒng)的新人來了又走，他始終泰然自若。剛過去一個禮拜，我就心下竊吼：“坑爹啊!”，也徹底體會到什么叫---絕對的權(quán)威、專家。該軟件系統(tǒng)，是公司發(fā)家的支柱產(chǎn)品，涉及十幾個國家x七八個機(jī)型，700 個文件 (C語言，所有.c .h檔)，十幾萬行代碼，盡兩百個跨模塊全局變量，編譯條件成百上千......(好吧，這是找借口、吐槽的節(jié)奏)。盡管有名義上的交接，和幾次和聲細(xì)語的密切指導(dǎo)。但真正獨立展開工作時，許多小功能增刪改，我都要折騰個好幾天才能厘清代碼調(diào)用關(guān)系、算法原 理，然后找到修改點謹(jǐn)慎細(xì)微龜速前行。進(jìn)度追蹤的人有的時候也催毛了，直接請專家大師出手，咔咔咔，不到半天就搞定了。當(dāng)然，前期我當(dāng)然盡量的”不恥上 問”，但人嘛，總是有遇到被激發(fā)“骨氣”的時候。這幾天，好不容易搞好一個全新的功能模塊，把代碼推送給他合并編譯。不曾想，出現(xiàn)了讓我泣血的一幕。我眼睜睜地、眼睜睜看著她把我辛苦敲入的代碼注釋/**/通通換成//，一份精美的代碼，頓時成渣。我詢問緣由，她的回答是: 當(dāng)代碼里面充滿注釋符號/**/時，她想要用/**/注釋整段代碼時，就會很麻煩。我理解了，因為/**/不支持嵌套。比如下面這樣的語句是編譯不過的。1 /*
2 a?=?b c;?/*?注釋?*/
3 */
4我的手抬了抬，終究作罷。雖然我感覺到尊嚴(yán)被踐踏，心愛的作品被蹂躪，但我還是開始反思。許多軟件規(guī)范、專家、有經(jīng)驗的工程，都建議或要求注釋代碼最好使用/**/，他們的理由大略如下:1"http://"進(jìn)行注釋不夠嚴(yán)謹(jǐn)例如:1?//?注釋語句???/
2a?=?b c;此時，a = b c在一些編譯器不會被執(zhí)行。因為"??/"會被編譯器當(dāng)作 \，變成C語言的換行符。于是這段代碼等同于// 注釋語句 a = b c ;就會被注釋掉。大家有興趣的，不妨去搜索一下"C語言 三字母詞"當(dāng)然，哪怕沒有??/， 自己打盹碰到delete鍵也是會屏蔽掉a=b c的。2"http://"的注釋來源于C 有些早期的C編譯器對這種注釋是不支持的。代碼要做到全平臺兼容，這點是必須要考慮的。因此，老外定義的C語言軟件規(guī)范，無論是MISRA還是CMMI，一般都要求所有代碼注釋必須使用/**/。君不見，那uCOS的最新版本源碼，所有注釋都是/**/。君不見，那STM32的最新固件庫，洋洋灑灑幾十個文件，通篇皆沒有用到//。正是基于這樣的理由，讓我的心中充滿了慍怒。但我仍然沒有當(dāng)場反駁她，因為這些理由還有些蒼白無力。1、當(dāng)時，那個什么三字母詞“??x”到底是什么我已經(jīng)忘了，沒法立刻做試驗編譯給她看，而且時候我里面做了編譯實驗，得到的是："filename.c", line xxxx: Warning: #2532-D: support for trigraphs is disabled xx代碼語句xx // ??/trigraph金山詞霸---> [traigra:f]三字母詞，看吧，編譯器都警告了，默認(rèn)是不支持的。2、而且，所謂的//是C 的，早期的c編譯器不支持。這點誰鳥啊，我們只要現(xiàn)在，只用最新版本的編譯器，所以，我還要繼續(xù)思考，我要維護(hù)這個傳統(tǒng)，為自己代言......我開始思考，還有什么強(qiáng)勁有力的理由，來支持我恪守的真理：C語言代碼注釋必須使用/**/。3我的三大理解倘若所有代碼里面的注釋用到/**/時，當(dāng)你要注釋掉這段代碼時，如果不想忍受編譯器的嵌套報警，又懶得把一個個/**/換成//的話。那么你還有如下選擇。1) 慎重思考下是否刪光這段代碼，如果還有些不舍，那就先"備份"(git推送)一下再刪光。因此，理由一：使用/**/注釋代碼，會使軟件系統(tǒng)減少冗余的僵尸代碼，鼓勵程序員的程序備份行為。2) 或者用編譯條件圈起來，如下。1#if?(XXX_ENABLE)
2????func(a,?b,?c);?/*?注釋?*/
3????......?/*?注釋?*/
4#endif那么你不得不考慮xxx的命名，如何更加一目了然，再寫點注釋什么的，表明對這段代碼“棄而不舍”的緣由。因此，理由二：使用/**/注釋代碼，會鼓勵程序員刪除代碼時，三思而后行，并且注明舍棄的理由。3) 當(dāng)然，偷懶的人還是會用 #if 0 #endif圈起來， 如下，1#if?0
2 func(a,?b,?c);?/*?注釋?*/
3 ......?/*?注釋?*/
4#endif而且不會寫任何注釋表明刪除的理由。然而，“#if 0”是一個如此的醒目，很容易成為一個評估軟件質(zhì)量、工作績效的搜索關(guān)鍵詞。從管理的角度，這個是可以量化的。因此，理由三: 使用/**/注釋代碼，有利于公司進(jìn)行軟件質(zhì)量控管，對程序員績效考核。版權(quán)申明：內(nèi)容來源網(wǎng)絡(luò)，版權(quán)歸原創(chuàng)者所有。除非無法確認(rèn)，我們都會標(biāo)明作者及出處，如有侵權(quán)煩請告知，我們會立即刪除并表示歉意。謝謝!
下載文檔
