笑死人不償命的代碼注釋裳朋,你忍住不笑算我輸病线!

真事兒,在公司的時候鲤嫡,曾經有一位技術很牛的前輩送挑,在代碼中的注釋上寫了一句“測個毛”,這不是重點暖眼,重點是他把這句話粘到了彈出框的文字上惕耕,自己測試一下代碼邏輯,就隨意打了這三個字诫肠,結果提交代碼忘記修改了司澎,后來在bug系統(tǒng)發(fā)現(xiàn)了這個bug,并得到了測試部老大的問候栋豫。

個人觀點挤安,只是經驗之談,歡迎來噴 丧鸯!

1蛤铜、在類級別,方法級別上最好加上注釋丛肢。

特別是那些邏輯復雜的围肥,難以用一句話描述清楚的內容,最好加上注釋摔踱,講清楚這個類虐先,或這個方法是用來干嘛的,有什么需要注意的地方派敷。這個注釋很重要蛹批,特別是這些代碼還要被其他人使用的時候,加上說明會方便很多篮愉。

2腐芍、在某些容易留坑的地方,最好加上注釋试躏。

這種地方很多時候是因為圖省事猪勇,或者沒時間等原因,只能暫時這么做颠蕴,但是需要提醒使用者注意泣刹≈觯或者懷疑隊友水平沒那么高,理解不了你的代碼椅您,某天來修改代碼并且容易改錯外冀。或者是因為這段代碼『特立獨行』掀泳,不是按照常規(guī)方式雪隧,你自己在這里耍了小聰明,或者用了自己設計的一些技巧性的東西员舵,怕別人看不懂脑沿。

3、涉及到業(yè)務邏輯的代碼马僻,比如某些字段需要加說明庄拇,之類的。

有些業(yè)務的東西巫玻,確實不是一兩句代碼就能扯清楚的丛忆,這種東西祠汇,加個注釋就好了仍秤。

4、因為修復某個bug而加進去的代碼可很。

改bug诗力,特別是改別人的bug的時候,如果不是進行大規(guī)模的重構我抠,而是往里面加小段代碼打補丁的時候苇本,最好加上注釋,否則這段代碼很奇怪菜拓,并且容易看不懂瓣窄。記住最好留上你的名字,不然后人看這個代碼都不知道該去罵誰纳鼎,hiahiahia~俺夕。

軟件開發(fā)學習之路http://www.zparkedu.com/

?著作權歸作者所有,轉載或內容合作請聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市贱鄙,隨后出現(xiàn)的幾起案子劝贸,更是在濱河造成了極大的恐慌,老刑警劉巖逗宁,帶你破解...
    沈念sama閱讀 211,376評論 6 491
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件映九,死亡現(xiàn)場離奇詭異,居然都是意外死亡瞎颗,警方通過查閱死者的電腦和手機件甥,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 90,126評論 2 385
  • 文/潘曉璐 我一進店門捌议,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人引有,你說我怎么就攤上這事禁灼。” “怎么了轿曙?”我有些...
    開封第一講書人閱讀 156,966評論 0 347
  • 文/不壞的土叔 我叫張陵弄捕,是天一觀的道長。 經常有香客問我导帝,道長守谓,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 56,432評論 1 283
  • 正文 為了忘掉前任您单,我火速辦了婚禮斋荞,結果婚禮上,老公的妹妹穿的比我還像新娘虐秦。我一直安慰自己平酿,他們只是感情好,可當我...
    茶點故事閱讀 65,519評論 6 385
  • 文/花漫 我一把揭開白布悦陋。 她就那樣靜靜地躺著蜈彼,像睡著了一般。 火紅的嫁衣襯著肌膚如雪俺驶。 梳的紋絲不亂的頭發(fā)上幸逆,一...
    開封第一講書人閱讀 49,792評論 1 290
  • 那天,我揣著相機與錄音暮现,去河邊找鬼还绘。 笑死,一個胖子當著我的面吹牛栖袋,可吹牛的內容都是我干的拍顷。 我是一名探鬼主播,決...
    沈念sama閱讀 38,933評論 3 406
  • 文/蒼蘭香墨 我猛地睜開眼塘幅,長吁一口氣:“原來是場噩夢啊……” “哼昔案!你這毒婦竟也來了?” 一聲冷哼從身側響起晌块,我...
    開封第一講書人閱讀 37,701評論 0 266
  • 序言:老撾萬榮一對情侶失蹤爱沟,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后匆背,有當地人在樹林里發(fā)現(xiàn)了一具尸體呼伸,經...
    沈念sama閱讀 44,143評論 1 303
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 36,488評論 2 327
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發(fā)現(xiàn)自己被綠了括享。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片搂根。...
    茶點故事閱讀 38,626評論 1 340
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖铃辖,靈堂內的尸體忽然破棺而出剩愧,到底是詐尸還是另有隱情,我是刑警寧澤娇斩,帶...
    沈念sama閱讀 34,292評論 4 329
  • 正文 年R本政府宣布仁卷,位于F島的核電站,受9級特大地震影響犬第,放射性物質發(fā)生泄漏锦积。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點故事閱讀 39,896評論 3 313
  • 文/蒙蒙 一歉嗓、第九天 我趴在偏房一處隱蔽的房頂上張望丰介。 院中可真熱鬧,春花似錦鉴分、人聲如沸哮幢。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,742評論 0 21
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽橙垢。三九已至,卻和暖如春碴裙,著一層夾襖步出監(jiān)牢的瞬間钢悲,已是汗流浹背点额。 一陣腳步聲響...
    開封第一講書人閱讀 31,977評論 1 265
  • 我被黑心中介騙來泰國打工舔株, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人还棱。 一個月前我還...
    沈念sama閱讀 46,324評論 2 360
  • 正文 我出身青樓载慈,卻偏偏與公主長得像,于是被迫代替她去往敵國和親珍手。 傳聞我的和親對象是個殘疾皇子办铡,可洞房花燭夜當晚...
    茶點故事閱讀 43,494評論 2 348

推薦閱讀更多精彩內容

  • Android 自定義View的各種姿勢1 Activity的顯示之ViewRootImpl詳解 Activity...
    passiontim閱讀 171,757評論 25 707
  • “愛情是兩個人的事,婚姻卻是兩個家庭的事” 琳要,似乎已經成了大家對婚姻認識的真理而存在著寡具。一場好的婚姻對于男女...
    竹小春閱讀 429評論 4 2
  • 往積極方面設想目標 設想目標時經常想如果達不到,會怎樣稚补,很少想到的是:我要如何做才能完成目標童叠?這種很多時侯...
    清不負此生閱讀 277評論 0 1
  • 前幾天《歡樂頌》迎來了大結局。這段時間课幕,關于劇中五個姑娘的討論也是長期霸屏厦坛。 大多數姑娘都是邱瑩瑩或者小關這樣的普...
    吃水的蝦米閱讀 460評論 0 0
  • 01 “你說杜秸,這個項目我熬了幾個通宵放仗,才完成得這么出彩。憑什么她們要在背后這么說我撬碟?”表妹忿忿不平地說诞挨。 大學畢業(yè)...
    文藝小麥閱讀 197評論 0 1