Eclipse Java注釋模板設定詳解

標籤：desc   designed   class   row   整理   style   comm   template   write   

網上的Eclipse注釋模板，在這裡稍稍整理一些比較常用的。

編輯注釋模板的方法：Window->Preference->Java->Code Style->Code Template 然後展開Comments節點就是所有需設定注釋的元素啦。現就每一個元素逐一介紹：

1.檔案(Files)注釋標籤：

/**   * All rights Reserved, Designed By www.tydic.com * @Title:  ${file_name}    * @Package ${package_name}    * @Description:    ${todo}(用一句話描述該檔案做什麼)    * @author: xxxxx      * @date:   ${date} ${time}    * @version V1.0  */  

 

2.類型(Types)注釋標籤（類的注釋）：

/**    * @ClassName:  ${type_name}    * @Description:${todo}(這裡用一句話描述這個類的作用)    * @author: xxxxx  * @date:   ${date} ${time} * ${tags}  */  

3.欄位(Fields)注釋標籤：

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

4.建構函式標籤：

/**    * @Title:  ${enclosing_type}    * @Description:    ${todo}(這裡用一句話描述這個方法的作用)    * @param:  ${tags}   * @throws    */  

5.方法(Methods)標籤：

/**    * @Title: ${enclosing_method}    * @Description: ${todo}(這裡用一句話描述這個方法的作用)    * @param: ${tags}       * @return: ${return_type}       * @throws    */  

6.覆蓋方法(Overriding Methods)標籤:

/**    * <p>Title: ${enclosing_method}</p>    * <p>Description: </p>    * ${tags}    * ${see_to_overridden}    */  

7.代表方法(Delegate Methods)標籤：

/**   * ${tags}   * ${see_to_target}   */  

8.getter方法標籤：

/**   * @Title:  ${enclosing_method} <BR>   * @Description: please write your description <BR>   * @return: ${field_type} <BR>   */  

9.setter方法標籤：

/**   * @Title:  ${enclosing_method} <BR>   * @Description: please write your description <BR>   * @return: ${field_type} <BR>   */  

Eclipse Java注釋模板設定詳解