注釋并不是純?nèi)坏暮?/h1>

注釋并不是純?nèi)坏暮?/p>

? ?“代碼與注釋”的關(guān)系削饵,我誠然的多次聽到這樣的一種說法岩瘦,“盡量每個函數(shù),都寫上詳細(xì)的注釋窿撬,這樣以后別人接收就很容易理解启昧。”其實劈伴,這樣的說法存在弊端密末。

? ? ?首先要明確一點,注釋到底是干什么用的跛璧。注釋的恰當(dāng)用法是彌補我們用代碼表達(dá)意圖時遭遇的失敗严里。換句話說,有意義的命名才是根本之道追城,如果我們無法準(zhǔn)確的找到有意義的命名刹碾,那么注釋可以增加代碼的可理解性。注釋不可以濫用座柱,也不可以過度的依賴注釋迷帜。其實,我一直認(rèn)為辆布,代碼根本不需要注釋瞬矩,因為注釋存在,是因為我們找不到對命名的良好表達(dá)方式锋玲。注釋可以說是一個補救措施景用。

? ? ?注釋的有點是,增加可讀性與可理解性惭蹂。

? 注釋的缺點是:可能因多個程序員的改動伞插,造成注釋內(nèi)容陳舊,提供錯誤信息盾碗。

? ? ?我一直不建議寫注釋的原因媚污,是因為注釋會說謊。一:就算是注釋廷雅,漢語的表達(dá)也可能存在詞不達(dá)意的情況耗美。二:代碼在變動京髓,在迭代,在修改商架,不幸的是注釋并不總是隨之變動堰怨。我們不可忽略的一點是,注釋存在的時間越久蛇摸,就離其所描述的代碼越遠(yuǎn)备图,也許是全然的錯誤。為什么我不建議寫注釋赶袄,很簡單揽涮,隨著人員的流動,項目的高速迭代饿肺,程序員能不能堅持長久的維護(hù)注釋蒋困,誰也不能保證。

? ? 我們應(yīng)該盡量做到敬辣,準(zhǔn)確的命名家破,真正好的程序員是找到困難的解決方案,盡量不去寫注釋购岗。

? ?說了注釋的很多缺點,其實注釋本身沒有錯门粪,錯的是我們使用它的時機與地方喊积。比如,警示的作用玄妈。如:“// 在此處共花費時間26小時”乾吻。這個就相當(dāng)?shù)挠杏茫驗槠渌绦騿T看了拟蜻,就知道绎签,業(yè)務(wù)邏輯復(fù)雜,修改時候要細(xì)心酝锅,多琢磨一下诡必。

? ?什么也比不上良好的代碼有用,什么也不會比亂起八糟的注釋更有本事?lián)v亂搔扁,什么也不會比陳舊爸舒,提供錯誤信息的注釋更有破壞性。適當(dāng)?shù)臅r機稿蹲,適當(dāng)?shù)奈恢檬褂米⑨屌っ悖梢允掳牍Ρ丁S缅e了苛聘,會浪費開發(fā)時間涂炎,影響項目進(jìn)度忠聚。

? 注釋并不是純?nèi)坏暮谩?/p>

閱讀原文

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者

  • 序言:七十年代末,一起剝皮案震驚了整個濱河市唱捣,隨后出現(xiàn)的幾起案子两蟀,更是在濱河造成了極大的恐慌,老刑警劉巖爷光,帶你破解...
    沈念sama閱讀 211,743評論 6 492
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件垫竞,死亡現(xiàn)場離奇詭異,居然都是意外死亡蛀序,警方通過查閱死者的電腦和手機欢瞪,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 90,296評論 3 385
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來徐裸,“玉大人遣鼓,你說我怎么就攤上這事≈睾兀” “怎么了骑祟?”我有些...
    開封第一講書人閱讀 157,285評論 0 348
  • 文/不壞的土叔 我叫張陵,是天一觀的道長气笙。 經(jīng)常有香客問我次企,道長,這世上最難降的妖魔是什么潜圃? 我笑而不...
    開封第一講書人閱讀 56,485評論 1 283
  • 正文 為了忘掉前任缸棵,我火速辦了婚禮,結(jié)果婚禮上谭期,老公的妹妹穿的比我還像新娘堵第。我一直安慰自己,他們只是感情好隧出,可當(dāng)我...
    茶點故事閱讀 65,581評論 6 386
  • 文/花漫 我一把揭開白布踏志。 她就那樣靜靜地躺著,像睡著了一般胀瞪。 火紅的嫁衣襯著肌膚如雪针余。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 49,821評論 1 290
  • 那天凄诞,我揣著相機與錄音涵紊,去河邊找鬼。 笑死幔摸,一個胖子當(dāng)著我的面吹牛摸柄,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播既忆,決...
    沈念sama閱讀 38,960評論 3 408
  • 文/蒼蘭香墨 我猛地睜開眼驱负,長吁一口氣:“原來是場噩夢啊……” “哼嗦玖!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起跃脊,我...
    開封第一講書人閱讀 37,719評論 0 266
  • 序言:老撾萬榮一對情侶失蹤宇挫,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后酪术,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體器瘪,經(jīng)...
    沈念sama閱讀 44,186評論 1 303
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 36,516評論 2 327
  • 正文 我和宋清朗相戀三年绘雁,在試婚紗的時候發(fā)現(xiàn)自己被綠了橡疼。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 38,650評論 1 340
  • 序言:一個原本活蹦亂跳的男人離奇死亡庐舟,死狀恐怖欣除,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情挪略,我是刑警寧澤历帚,帶...
    沈念sama閱讀 34,329評論 4 330
  • 正文 年R本政府宣布,位于F島的核電站杠娱,受9級特大地震影響挽牢,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜摊求,卻給世界環(huán)境...
    茶點故事閱讀 39,936評論 3 313
  • 文/蒙蒙 一卓研、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧睹簇,春花似錦、人聲如沸寥闪。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,757評論 0 21
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽疲憋。三九已至凿渊,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間缚柳,已是汗流浹背埃脏。 一陣腳步聲響...
    開封第一講書人閱讀 31,991評論 1 266
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留秋忙,地道東北人彩掐。 一個月前我還...
    沈念sama閱讀 46,370評論 2 360
  • 正文 我出身青樓,卻偏偏與公主長得像灰追,于是被迫代替她去往敵國和親堵幽。 傳聞我的和親對象是個殘疾皇子狗超,可洞房花燭夜當(dāng)晚...
    茶點故事閱讀 43,527評論 2 349

推薦閱讀更多精彩內(nèi)容

  • Spring Cloud為開發(fā)人員提供了快速構(gòu)建分布式系統(tǒng)中一些常見模式的工具(例如配置管理,服務(wù)發(fā)現(xiàn)朴下,斷路器努咐,智...
    卡卡羅2017閱讀 134,633評論 18 139
  • Android 自定義View的各種姿勢1 Activity的顯示之ViewRootImpl詳解 Activity...
    passiontim閱讀 171,777評論 25 707
  • error code(錯誤代碼)=0是操作成功完成。error code(錯誤代碼)=1是功能錯誤殴胧。error c...
    Heikki_閱讀 3,368評論 1 9
  • 從今年的三月到現(xiàn)在渗稍,我一共瘦了十二斤。我把這個消息公布在朋友圈以后团滥,除了“一方有難竿屹,八方點贊”的損友黨,大部分女孩...
    XSP薛老爺閱讀 191評論 0 5
  • 《頭腦特工隊》這是一部非常好看的電影,用動畫片的方式描述了人的各種情緒如何進(jìn)行分工合作厨钻。 今天重新聽了冰冰老師的《...
    雷清鳳閱讀 306評論 0 2