eclipse代碼注釋的設定

1. eclipse使用者名稱的設定：

在eclipse的安裝路徑下，開啟eclipse.ini的設定檔，如下圖：

在-vmargs下加入：-Duser.name=你的名字

2. 注釋格式以及各個主要簡介

（1）.單行(single-line)注釋：“//……”

（2）.塊(block)注釋：“/*……*/”

（3）.文檔注釋：“/**……*/”

（4）.javadoc注釋標籤文法

@author   對類的說明標明開發該類別模組的作者

@version   對類的說明標明該類別模組的版本

@see    對類、屬性、方法的說明參考轉向，也就是相關主題

@param    對方法的說明對方法中某參數的說明

@return   對方法的說明對方法傳回值的說明

@exception  對方法的說明對方法可能拋出的異常進行說明

@return_type傳回型別

@date 日期

@time時間

  3類、方法、重寫方法等類型的注釋添加

打來：Window->Preference->Java->Code Style->Code Template 然後展開Comments節點,選中你要添加註釋的類型，

然後點擊edit，就是所有需設定注釋的元素。現就每一個元素逐一介紹：

點擊edit後，在pattern裡按“ctrl“+”/”鍵，選擇要添加的種類，例如日期，作者、時間、傳回型別等等……

設定好以後，會在上圖的pattern下產生相應代碼，如下圖所示：

（1）檔案(Files)注釋標籤：

目前沒有用到，可以不用設定。 （2）類型(Types)注釋標籤（類的注釋）：

規範：

/**

 * 類的描述

 * @authoryourname

* @Time 2012-11-20 14:49:01

 *

 */

注釋的pattern:

/**

 * @Description:${todo}

 * @author:${user}

 * @time:${date} ${time}

 */ （3）欄位(Fields)注釋標籤：

/**
* @Description: ${field} : ${todo}(用一句話描述這個變數表示什麼)
*/

暫時用不到

（4）建構函式標籤(Constructor)：

規範：

/**

     * 構造方法的描述

     * @param name

     *       按鈕的上顯示的文字

     */

 

Pattern:

/**

 * @Description:${todo}

 * ${tags}

 */ （5）方法(Methods)標籤：（介面和其實作類別的方法，都要加註釋）

注釋規範：

/**

     * 為按鈕添加顏色

     *@param color

按鈕的顏色

*@return

*@exception  (方法有異常的話加)

* @author Administrator

* @Time 2012-11-20 15:02:29

 

     */

 

Pattern:

 

/**

 * @Description:${todo}

 * ${tags}

 * ${return_type}

 * @exception:

 * @author: ${user}

 * @time:${date} ${time}

 */ （6）覆蓋方法(Overriding Methods)標籤： （7）代表方法(Delegate Methods)標籤：
（8）getter方法標籤： （9）setter方法標籤：

這些暫時沒有定義，可以按照自己的方式添加註釋。