[導讀]來源于網(wǎng)絡(luò)沒有血案，但有些沖突。不是代碼bug，我要講注釋風格。這位看官，既然來了，且讀且評吧。故事是真實的，如有雷同純屬巧合。故事是真實的，如有雷同純屬巧合。事情是這樣的，有人離職，公司調(diào)我補缺。那個系統(tǒng)一直有個工程師在維護，參與該系統(tǒng)的新人來了又走，他始終泰然自若。剛過去一個...
來源于網(wǎng)絡(luò)
沒有血案，但有些沖突。不是代碼bug，我要講注釋風格。
這位看官，既然來了，且讀且評吧。故事是真實的，如有雷同純屬巧合。故事是真實的，如有雷同純屬巧合。事情是這樣的，有人離職，公司調(diào)我補缺。那個系統(tǒng)一直有個工程師在維護，參與該系統(tǒng)的新人來了又走，他始終泰然自若。剛過去一個禮拜，我就心下竊吼：“坑爹啊!”，也徹底體會到什么叫---絕對的權(quán)威、專家。該軟件系統(tǒng)，是公司發(fā)家的支柱產(chǎn)品，涉及十幾個國家x七八個機型，700 個文件 (C語言，所有.c .h檔)，十幾萬行代碼，盡兩百個跨模塊全局變量，編譯條件成百上千......(好吧，這是找借口、吐槽的節(jié)奏)。盡管有名義上的交接，和幾次和聲細語的密切指導。但真正獨立展開工作時，許多小功能增刪改，我都要折騰個好幾天才能厘清代碼調(diào)用關(guān)系、算法原 理，然后找到修改點謹慎細微龜速前行。進度追蹤的人有的時候也催毛了，直接請專家大師出手，咔咔咔，不到半天就搞定了。當然，前期我當然盡量的”不恥上 問”，但人嘛，總是有遇到被激發(fā)“骨氣”的時候。這幾天，好不容易搞好一個全新的功能模塊，把代碼推送給他合并編譯。不曾想，出現(xiàn)了讓我泣血的一幕。我眼睜睜地、眼睜睜看著她把我辛苦敲入的代碼注釋/**/通通換成//，一份精美的代碼，頓時成渣。我詢問緣由，她的回答是: 當代碼里面充滿注釋符號/**/時，她想要用/**/注釋整段代碼時，就會很麻煩。我理解了，因為/**/不支持嵌套。比如下面這樣的語句是編譯不過的。1 /*
2 a?=?b c;?/*?注釋?*/3 *
/
4我的手抬了抬，終究作罷。雖然我感覺到尊嚴被踐踏，心愛的作品被蹂躪，但我還是開始反思。許多軟件規(guī)范、專家、有經(jīng)驗的工程，都建議或要求注釋代碼最好使用/**/，他們的理由大略如下:1"http://"進行注釋不夠嚴謹
例如:1?
//?注釋語句???/2a?=?b c;
此時，a = b c在一些編譯器不會被執(zhí)行。因為"??/"會被編譯器當作 \，變成C語言的換行符。于是這段代碼等同于// 注釋語句 a = b c ;就會被注釋掉。大家有興趣的，不妨去搜索一下"C語言 三字母詞"當然，哪怕沒有??/， 自己打盹碰到delete鍵也是會屏蔽掉a=b c的。2"http://"的注釋來源于C
有些早期的C編譯器對這種注釋是不支持的。代碼要做到全平臺兼容，這點是必須要考慮的。因此，老外定義的C語言軟件規(guī)范，無論是MISRA還是CMMI，一般都要求所有代碼注釋必須使用/**/。君不見，那uCOS的最新版本源碼，所有注釋都是/**/。君不見，那STM32的最新固件庫，洋洋灑灑幾十個文件，通篇皆沒有用到//。正是基于這樣的理由，讓我的心中充滿了慍怒。但我仍然沒有當場反駁她，因為這些理由還有些蒼白無力。1、當時，那個什么三字母詞“??x”到底是什么我已經(jīng)忘了，沒法立刻做試驗編譯給她看，而且時候我里面做了編譯實驗，得到的是："filename.c", line xxxx: Warning: #2532-D: support for trigraphs is disabled xx代碼語句xx // ??/trigraph金山詞霸---> [traigra:f]三字母詞，看吧，編譯器都警告了，默認是不支持的。2、而且，所謂的//是C 的，早期的c編譯器不支持。這點誰鳥啊，我們只要現(xiàn)在，只用最新版本的編譯器，所以，我還要繼續(xù)思考，我要維護這個傳統(tǒng)，為自己代言......我開始思考，還有什么強勁有力的理由，來支持我恪守的真理：C語言代碼注釋必須使用/**/。3我的三大理解
倘若所有代碼里面的注釋用到/**/時，當你要注釋掉這段代碼時，如果不想忍受編譯器的嵌套報警，又懶得把一個個/**/換成//的話。那么你還有如下選擇。1) 慎重思考下是否刪光這段代碼，如果還有些不舍，那就先"備份"(git推送)一下再刪光。因此，理由一：使用/**/注釋代碼，會使軟件系統(tǒng)減少冗余的僵尸代碼，鼓勵程序員的程序備份行為。2) 或者用編譯條件圈起來，如下。1#
if?(XXX_ENABLE)
2????func(a,?b,?c);?
/*?注釋?*/3????......?
/*?注釋?*/4#endif
那么你不得不考慮xxx的命名，如何更加一目了然，再寫點注釋什么的，表明對這段代碼“棄而不舍”的緣由。因此，理由二：使用/**/注釋代碼，會鼓勵程序員刪除代碼時，三思而后行，并且注明舍棄的理由。3) 當然，偷懶的人還是會用 #if 0 #endif圈起來， 如下，1#
if?
02 func(a,?b,?c);?
/*?注釋?*/3 ......?
/*?注釋?*/4#endif
而且不會寫任何注釋表明刪除的理由。然而，“#if 0”是一個如此的醒目，很容易成為一個評估軟件質(zhì)量、工作績效的搜索關(guān)鍵詞。從管理的角度，這個是可以量化的。因此，理由三: 使用/**/注釋代碼，有利于公司進行軟件質(zhì)量控管，對程序員績效考核。版權(quán)申明：內(nèi)容來源網(wǎng)絡(luò)，版權(quán)歸原創(chuàng)者所有。除非無法確認，我們都會標明作者及出處，如有侵權(quán)煩請告知，我們會立即刪除并表示歉意。謝謝!
本站聲明： 本文章由作者或相關(guān)機構(gòu)授權(quán)發(fā)布，目的在于傳遞更多信息，并不代表本站贊同其觀點，本站亦不保證或承諾內(nèi)容真實性等。需要轉(zhuǎn)載請聯(lián)系該專欄作者，如若文章內(nèi)容侵犯您的權(quán)益，請及時聯(lián)系本站刪除。
9月2日消息，不造車的華為或?qū)⒋呱龈蟮莫毥谦F公司，隨著阿維塔和賽力斯的入局，華為引望愈發(fā)顯得引人矚目。
關(guān)鍵字：
阿維塔
塞力斯
華為
加利福尼亞州圣克拉拉縣2024年8月30日 /美通社/ -- 數(shù)字化轉(zhuǎn)型技術(shù)解決方案公司Trianz今天宣布，該公司與Amazon Web Services （AWS）簽訂了...
關(guān)鍵字：
AWS
AN
BSP
數(shù)字化
倫敦2024年8月29日 /美通社/ -- 英國汽車技術(shù)公司SODA.Auto推出其旗艦產(chǎn)品SODA V，這是全球首款涵蓋汽車工程師從創(chuàng)意到認證的所有需求的工具，可用于創(chuàng)建軟件定義汽車。 SODA V工具的開發(fā)耗時1.5...
關(guān)鍵字：
汽車
人工智能
智能驅(qū)動
BSP
北京2024年8月28日 /美通社/ -- 越來越多用戶希望企業(yè)業(yè)務(wù)能7×24不間斷運行，同時企業(yè)卻面臨越來越多業(yè)務(wù)中斷的風險，如企業(yè)系統(tǒng)復雜性的增加，頻繁的功能更新和發(fā)布等。如何確保業(yè)務(wù)連續(xù)性，提升韌性，成...
關(guān)鍵字：
亞馬遜
解密
控制平面
BSP
8月30日消息，據(jù)媒體報道，騰訊和網(wǎng)易近期正在縮減他們對日本游戲市場的投資。
關(guān)鍵字：
騰訊
編碼器
CPU
8月28日消息，今天上午，2024中國國際大數(shù)據(jù)產(chǎn)業(yè)博覽會開幕式在貴陽舉行，華為董事、質(zhì)量流程IT總裁陶景文發(fā)表了演講。
關(guān)鍵字：
華為
12nm
EDA
半導體
8月28日消息，在2024中國國際大數(shù)據(jù)產(chǎn)業(yè)博覽會上，華為常務(wù)董事、華為云CEO張平安發(fā)表演講稱，數(shù)字世界的話語權(quán)最終是由生態(tài)的繁榮決定的。
關(guān)鍵字：
華為
12nm
手機
衛(wèi)星通信
要點： 有效應(yīng)對環(huán)境變化，經(jīng)營業(yè)績穩(wěn)中有升 落實提質(zhì)增效舉措，毛利潤率延續(xù)升勢 戰(zhàn)略布局成效顯著，戰(zhàn)新業(yè)務(wù)引領(lǐng)增長 以科技創(chuàng)新為引領(lǐng)，提升企業(yè)核心競爭力 堅持高質(zhì)量發(fā)展策略，塑強核心競爭優(yōu)勢...
關(guān)鍵字：
通信
BSP
電信運營商
數(shù)字經(jīng)濟
北京2024年8月27日 /美通社/ -- 8月21日，由中央廣播電視總臺與中國電影電視技術(shù)學會聯(lián)合牽頭組建的NVI技術(shù)創(chuàng)新聯(lián)盟在BIRTV2024超高清全產(chǎn)業(yè)鏈發(fā)展研討會上宣布正式成立。 活動現(xiàn)場 NVI技術(shù)創(chuàng)新聯(lián)...
關(guān)鍵字：
VI
傳輸協(xié)議
音頻
BSP
北京2024年8月27日 /美通社/ -- 在8月23日舉辦的2024年長三角生態(tài)綠色一體化發(fā)展示范區(qū)聯(lián)合招商會上，軟通動力信息技術(shù)（集團）股份有限公司（以下簡稱"軟通動力"）與長三角投資（上海）有限...
關(guān)鍵字：
BSP
信息技術(shù)
山海路引?嵐悅新程 三亞2024年8月27日 /美通社/ --?近日，海南地區(qū)六家凱悅系酒店與中國高端新能源車企嵐圖汽車（VOYAH）正式達成戰(zhàn)略合作協(xié)議。這一合作標志著兩大品牌在高端出行體驗和環(huán)保理念上的深度融合，將...
關(guān)鍵字：
新能源
BSP
PLAYER
ASIA
上海2024年8月28日 /美通社/ -- 8月26日至8月28日，AHN LAN安嵐與股神巴菲特的孫女妮可?巴菲特共同開啟了一場自然和藝術(shù)的療愈之旅。 妮可·巴菲特在療愈之旅活動現(xiàn)場合影 ...
關(guān)鍵字：
MIDDOT
BSP
LAN
SPI
8月29日消息，近日，華為董事、質(zhì)量流程IT總裁陶景文在中國國際大數(shù)據(jù)產(chǎn)業(yè)博覽會開幕式上表示，中國科技企業(yè)不應(yīng)怕美國對其封鎖。
關(guān)鍵字：
華為
12nm
EDA
半導體
上海2024年8月26日 /美通社/ -- 近日，全球領(lǐng)先的消費者研究與零售監(jiān)測公司尼爾森IQ（NielsenIQ）迎來進入中國市場四十周年的重要里程碑，正式翻開在華發(fā)展新篇章。自改革開放以來，中國市場不斷展現(xiàn)出前所未有...
關(guān)鍵字：
BSP
NI
SE
TRACE
上海2024年8月26日 /美通社/ -- 第二十二屆跨盈年度B2B營銷高管峰會(CC2025)將于2025年1月15-17日在上海舉辦，本次峰會早鳥票注冊通道開啟，截止時間10月11日。 了解更多會議信息：cc.co...
關(guān)鍵字：
BSP
COM
AI
INDEX
上海2024年8月26日 /美通社/ -- 今日，高端全合成潤滑油品牌美孚1號攜手品牌體驗官周冠宇，開啟全新旅程，助力廣大車主通過駕駛?cè)ヌ剿鞲鼜V闊的世界。在全新發(fā)布的品牌視頻中，周冠宇及不同背景的消費者表達了對駕駛的熱愛...
關(guān)鍵字：
BSP
汽車制造
此次發(fā)布標志著Cision首次為亞太市場量身定制全方位的媒體監(jiān)測服務(wù)。 芝加哥2024年8月27日 /美通社/ -- 消費者和媒體情報、互動及傳播解決方案的全球領(lǐng)導者Cis...
關(guān)鍵字：
CIS
IO
SI
BSP
上海2024年8月27日 /美通社/ -- 近來，具有強大學習、理解和多模態(tài)處理能力的大模型迅猛發(fā)展，正在給人類的生產(chǎn)、生活帶來革命性的變化。在這一變革浪潮中，物聯(lián)網(wǎng)成為了大模型技術(shù)發(fā)揮作用的重要陣地。 作為全球領(lǐng)先的...
關(guān)鍵字：
模型
移遠通信
BSP
高通
北京2024年8月27日 /美通社/ -- 高途教育科技公司（紐約證券交易所股票代碼：GOTU）（"高途"或"公司"），一家技術(shù)驅(qū)動的在線直播大班培訓機構(gòu)，今日發(fā)布截至2024年6月30日第二季度未經(jīng)審計財務(wù)報告。 2...
關(guān)鍵字：
BSP
電話會議
COM
TE
8月26日消息，華為公司最近正式啟動了“華為AI百校計劃”，向國內(nèi)高校提供基于昇騰云服務(wù)的AI計算資源。
關(guān)鍵字：
華為
12nm
EDA
半導體
下載文檔
