摘要

  習慣寫註釋不一定代表技術強，但是一個習慣寫註釋的程式設計師一定是個好程式設計師，至少寫的程式碼美觀，有益於後期維護。程式碼其實就是一種藝術品，如果有裝飾的註釋，那簡直就是美上加美，讓人賞析悅目。
  我們都知道eclipse中可以快捷的為類，方法和資料域添加註釋，方法為/**+回車，預設的樣式為：

  很明顯這個類註釋只含有作者的資訊，如果我們想為其新增類名、描述、建立時間、版本資訊等，那該如何呢？

操作

  開啟Eclipse，選擇導航欄中Window->Perferences->Java->Code Style->Code Templates後，進入如下介面：

利用我的模板

  Copy以下格式(這是我喜歡用的，你也可以自行修改)放到編輯版中：

/**
 * @ClassName ${type_name}
 * @Description 
 * @Author Meng Yi
 * @Date ${date} ${time}
 * ${tags}
 */

  確定後，試驗一下樣式：

自行新增

  在編輯版中每一行都要以*開頭，然後@後面跟一個描述型單詞，不一定非得用系統自帶，也可以自行寫，比如系統的author，後面跟的值為${user},此user是個變數，我們可以在編輯版的中 insert variable裡這個值，注意 insert variable裡全是變數，關聯專案或者系統。變數值必須放在${}中。
如何修改作者資訊呢？
  user的值自動對應你的系統管理員的名字，如果你想修改為其他，就把${user}刪掉，然後用自己想要名字替代，這是靜態名字，即字串。
如何新增具體的時間呢？
  @date ${date} ${time}

提取註釋文件

Java提供一個很好的工具包，就是能把程式碼中註釋抽取出來形成HTML文件，方便閱讀，效果還不錯！

方式一：doc視窗下

我們在doc視窗下 cd 到我們 源程式的目錄下，然後javadoc 程式名.java
即可在當前目錄下形成我們的要的文件。
這裡以這個類為例：

package com.study.mengyi.object;
/**
 *
 * @ClassName Test1
 * @Description
 * @Author Meng Yi
 * @Date 2017年7月13日 下午10:05:49
 */
public class Test1 {
    int x;
    char y;
    public static void main(String[] args){
        Test1 test1 = new Test1();
        System.out.println(test1.x);
        System.out.println(test1.y);
    }
}

doc視窗下cd 到本程式的路徑

方式二 Eclipse

project->generate javadoc

finish即可，然後我們就可以去找index,html看我們的註釋文件了~

效果還不錯！