優(yōu)雅編程之這樣注釋代碼隘道,你就“正常”了(一)

開心一笑

【有一對(duì)男女正在吃晚餐,那個(gè)女生一直問那個(gè)男生:你愛不愛我? 男生看了女生一眼又繼續(xù)吃晚餐 女生很生氣又再問了一次:你愛不愛我远舅? 男生終于說:愛 女生又問:那你要怎么證明序六? 忽然男生從口袋里拿了三十元出來,且問女生:你有沒有十元余佃? 女生拿了十元給了男生......男生就把四十元放在桌上 過了一會(huì)兒..... 女生很生氣的問男生:你到底要不要證明你愛我爸畈稀坏瘩!男生說:我己經(jīng)證明了啊!四十?dāng)[在眼前壤巷! 省得麻煩】

提出問題

項(xiàng)目中的代碼如何注釋才合格宙彪?铅忿??

解決問題

下面是來自《代碼整潔之道》中自己的一些簡單總結(jié):

1)觀念:整潔清楚的代碼比注釋要好得多渗鬼,代碼即注釋命锄,真正好的注釋就是考慮不用寫注釋,注釋就是一種失斒幻啊;

2)刪掉被注釋掉的代碼骗污;

3)TODO注釋崇猫,提示尚未完成的工作;

4)真正需要注釋的地方:

  • 提供法律信息
  • 具有警示性的注釋需忿;
  • 描述一些業(yè)務(wù)場景诅炉;
  • 有些函數(shù)現(xiàn)在還是一個(gè)空殼,但在將來可能有用贴谎,有必要寫

5)避免括號(hào)后面的注釋汞扎;

下面提供一個(gè)例子季稳,方便理解:

package com.hwy.test;

/**
 * 代碼整潔之道
 * Created by Ay on 2016/7/11.
 */
public class CodeCleanTest {

    public static void main(String[] args) {

        /** 這段代碼是不需要注釋的,看方法名稱就可以清楚知道意圖了 **/
        engagements();
        boolean isMerryMe =  canMerryMe();
        if(isMerryMe){//避免括號(hào)后面的注釋擅这,例如這

            getMarried();
            /** 刪掉被注釋掉的代碼; **/
            //String ring = "";
        }

        /** TODO注釋景鼠,提示尚未完成的工作 **/
        //TODO 結(jié)婚生子

        /** 悄悄話內(nèi)容,這里涉及到一些業(yè)務(wù)上的事仲翎,所以需要注釋下 **/
        String whisperContent =  getwhisperContent();
    }


    /**
     * 獲得悄悄話內(nèi)容
     * @return
     */
    public static String getwhisperContent(){
        return "XXX OOO";
    }

    public static void engagements(){
        System.out.println("約會(huì)");
    }

    public static boolean canMerryMe(){
        boolean isLoveMe = true;
        if(isLoveMe)return true;
        return false;
    }

    public static void getMarried(){
        System.out.println("結(jié)婚");
    }

}
感悟

讀書感悟

來自《Zero to One》

  • 在科技劇烈改變世界的今天,想要成功铛漓,你必須在一切發(fā)生之前研究結(jié)局溯香。
  • 創(chuàng)新不是從1到N,而是從0到1
  • 如果你以講故事的方式來對(duì)描述一個(gè)事物的話浓恶,人類往往都很樂意去給出反饋玫坛。所有的故事往往都使用同樣的基礎(chǔ)框架。下面就是一個(gè)簡單的來自著名的皮克薩斯動(dòng)畫工作室的告訴我們應(yīng)該如何說故事的框架規(guī)則:
    在過去()包晰。每一天()湿镀。有一天()炕吸。因此() 。因此()勉痴。直到最后()赫模。
  • 列夫托爾斯泰《安娜 卡列尼娜》所說的:“幸福的家庭總是相似的,不幸的家庭各有各的不幸”
  • 對(duì)未來不明確的悲觀主義者: 一個(gè)對(duì)未來不明確的悲觀主義者看到的未來是陰郁的蒸矛,但卻是束手無策的瀑罗,所以這種人會(huì)喜歡把錢存起來以應(yīng)對(duì)不明確的未來,卻也正是因?yàn)槲磥淼牟幻鞔_而不會(huì)去進(jìn)行投資雏掠。
  • 對(duì)未來明確的悲觀主義者:在對(duì)未來明確的悲觀主義者相信未來是可知的斩祭,但卻是暗淡的,所以必須提前做好準(zhǔn)備磁玉。所以貧困點(diǎn)的就能省則省停忿,有點(diǎn)錢的就會(huì)大肆投資掠取金錢以備‘寒冬‘的到來。
  • 對(duì)未來明確的樂觀主義者:在對(duì)未來明確的樂觀主義者眼中蚊伞,如果計(jì)劃縝密席赂,工作努力,未來會(huì)比現(xiàn)在更好时迫。所以這樣的人都不會(huì)寄希望于儲(chǔ)蓄颅停,而是堅(jiān)信未來是光明的,更愿意去投資去開創(chuàng)事業(yè)掠拳,賺取更大的利益癞揉!
  • 對(duì)未來不明確的樂觀主義者:一個(gè)對(duì)未來不明確的樂觀主義者只知道未來會(huì)變得越來越好,卻不知道究竟有多好溺欧,因此不去定制具體計(jì)劃喊熟。他想在未來獲利,但是卻沒有必要制定具體計(jì)劃姐刁。
  • 探索秘密的最佳處所就是無人關(guān)注的地方芥牌。

其他

如果有帶給你一絲絲小快樂,就讓快樂繼續(xù)傳遞下去聂使,歡迎轉(zhuǎn)載壁拉,點(diǎn)贊,頂柏靶,歡迎留下寶貴的意見弃理,多謝支持!

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末屎蜓,一起剝皮案震驚了整個(gè)濱河市痘昌,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖辆苔,帶你破解...
    沈念sama閱讀 211,265評(píng)論 6 490
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件笔诵,死亡現(xiàn)場離奇詭異,居然都是意外死亡姑子,警方通過查閱死者的電腦和手機(jī)乎婿,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 90,078評(píng)論 2 385
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來街佑,“玉大人谢翎,你說我怎么就攤上這事°逯迹” “怎么了森逮?”我有些...
    開封第一講書人閱讀 156,852評(píng)論 0 347
  • 文/不壞的土叔 我叫張陵,是天一觀的道長磁携。 經(jīng)常有香客問我褒侧,道長,這世上最難降的妖魔是什么谊迄? 我笑而不...
    開封第一講書人閱讀 56,408評(píng)論 1 283
  • 正文 為了忘掉前任闷供,我火速辦了婚禮,結(jié)果婚禮上统诺,老公的妹妹穿的比我還像新娘歪脏。我一直安慰自己,他們只是感情好粮呢,可當(dāng)我...
    茶點(diǎn)故事閱讀 65,445評(píng)論 5 384
  • 文/花漫 我一把揭開白布婿失。 她就那樣靜靜地躺著,像睡著了一般啄寡。 火紅的嫁衣襯著肌膚如雪豪硅。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 49,772評(píng)論 1 290
  • 那天挺物,我揣著相機(jī)與錄音懒浮,去河邊找鬼。 笑死姻乓,一個(gè)胖子當(dāng)著我的面吹牛嵌溢,可吹牛的內(nèi)容都是我干的眯牧。 我是一名探鬼主播蹋岩,決...
    沈念sama閱讀 38,921評(píng)論 3 406
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼学少!你這毒婦竟也來了剪个?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 37,688評(píng)論 0 266
  • 序言:老撾萬榮一對(duì)情侶失蹤版确,失蹤者是張志新(化名)和其女友劉穎扣囊,沒想到半個(gè)月后乎折,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 44,130評(píng)論 1 303
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡侵歇,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 36,467評(píng)論 2 325
  • 正文 我和宋清朗相戀三年骂澄,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片惕虑。...
    茶點(diǎn)故事閱讀 38,617評(píng)論 1 340
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡坟冲,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出溃蔫,到底是詐尸還是另有隱情健提,我是刑警寧澤,帶...
    沈念sama閱讀 34,276評(píng)論 4 329
  • 正文 年R本政府宣布伟叛,位于F島的核電站私痹,受9級(jí)特大地震影響,放射性物質(zhì)發(fā)生泄漏统刮。R本人自食惡果不足惜紊遵,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 39,882評(píng)論 3 312
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望侥蒙。 院中可真熱鬧癞蚕,春花似錦、人聲如沸辉哥。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,740評(píng)論 0 21
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽醋旦。三九已至恒水,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間饲齐,已是汗流浹背钉凌。 一陣腳步聲響...
    開封第一講書人閱讀 31,967評(píng)論 1 265
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留捂人,地道東北人御雕。 一個(gè)月前我還...
    沈念sama閱讀 46,315評(píng)論 2 360
  • 正文 我出身青樓,卻偏偏與公主長得像滥搭,于是被迫代替她去往敵國和親酸纲。 傳聞我的和親對(duì)象是個(gè)殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 43,486評(píng)論 2 348

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