優(yōu)雅編程之這樣注釋代碼,你就“正?!绷耍ㄒ唬?/h2>

開心一笑

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

提出問題

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

解決問題

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

1)觀念:整潔清楚的代碼比注釋要好得多,代碼即注釋,真正好的注釋就是考慮不用寫注釋,注釋就是一種失?。?/strong>

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

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

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

  • 提供法律信息
  • 具有警示性的注釋;
  • 描述一些業(yè)務(wù)場(chǎng)景;
  • 有些函數(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è)簡(jiǎn)單的來自著名的皮克薩斯動(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)容合作請(qǐng)聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時(shí)請(qǐng)結(jié)合常識(shí)與多方信息審慎甄別。
平臺(tái)聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡(jiǎn)書系信息發(fā)布平臺(tái),僅提供信息存儲(chǔ)服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容