昨天把之前的想法和yj交流后，發現其中缺失代碼格式化中很重要的一塊，就是每個方法的注釋。方法注釋用于說明該方法的各項信息，比如創建人、創建日期、主要功能及輸入輸出的說明。另外還了解到規范化方法注釋可以用于自動生成JavaDoc，看起來和Java幫助文檔很類似的項目說明文檔。

今天找到eclipse中設置方法注釋模板并使用方法注釋的方法。

設置方法注釋模板：選擇eclipse菜單欄中【窗口】下的【首選項】，展開左邊樹到Java->代碼樣式->代碼模板，展開右邊出現的對話框中的注釋->方法，點擊右邊的【編輯】按鈕。編輯其中的內容。也可以點擊下面的【插入變量】按鈕添加變量。例如：

/**

 * @author ${user}

 * 功能：

 * ${tags}
 */

其中@author是JavaDoc的標示，帶$符號的是變量。

使用時鼠標放置在需要添加注釋的方法內部的任意位置。點擊菜單欄中【源代碼】下的【添加Javadoc注釋】，或者使用快捷鍵Alt+Shift+J，則eclipse自動在該方法前面添加注釋，例如public static void main(String[] args)生成如下注釋：

    /**

     * @author hfm

     * 功能：

     * @param args

     */