1. 程式人生 > >Eclipse自動生成作者、日期註釋等功能設置

Eclipse自動生成作者、日期註釋等功能設置

XP 生成 types create replace templates lan pro name

在使用Eclipse 編寫Java代碼時,自動生成的註釋信息都是按照預先設置好的格式生成的。

修改作者、日期註釋格式:打開Windows->Preferences->Java->Code Style->Code Templates,點擊右邊窗口中的Comments,可以看到有很多選項,我們便可對此註釋信息模板進行編輯。

如我們希望在一個Java文件的開頭設置作者信息、日期信息。

選擇Types,點擊Edit,將

/**

* @author ${user}

* ${tags}

*/

將${user}刪除,改成你希望顯示的名字;將${tags}刪除,點擊Insert Variable,選擇Date,這樣就會自動生成日期信息。在你需要添加註釋的地方點擊Sources->Ganarate Element Comment,或者使用快捷鍵 Alt+Shift+J ,則 eclipse 自動在該類前面添加註釋。

註釋的規範如下:

文件註釋標簽:

/**

* <p>Title: ${file_name}</p>

* <p>Description: </p>

* <p>Copyright: Copyright (c) 2007</p>

* <p>Company: LTGames</p>

* @author linrz

* @date ${date}

* @version 1.0

*/
類型註釋標簽(類的註釋):

/**

* <p>Title: ${type_name}</p>

* <p>Description: </p>

* <p>Company: LTGames</p>

* @author linrz

* @date ${date}

*/
字段註釋標簽:

/** ${field}*/

構造函數標簽:

/**

* <p>Title: </p>

* <p>Description: </p>

* ${tags}

*/

方法標簽:

/**

* <p>Title: ${enclosing_method}</p>

* <p>Description: </p>

* ${tags}

*/

覆蓋方法標簽:

/* (非 Javadoc)

* <p>Title: ${enclosing_method}</p>

* <p>Description: </p>

* ${tags}

* ${see_to_overridden}

*/

代表方法標簽:

/**

* ${tags}

* ${see_to_target}

*/

getter方法標簽:

/**

* @return ${bare_field_name}

*/

setter方法標簽:

/**

* @param ${param} 要設置的 ${bare_field_name}

*/

環境說明:
WindowsXP sp3
Eclipse3.6 Helios Release

一、.java 文件部分
---------------------

eclipse-->windows-->preferences-->Java-->Code Style-->Code Templates-->Code-->New Java files-->單擊[edit]按鈕

在文件首行,添加如下內容:

Java代碼

${filecomment}

${package_declaration}

/**

* 創建時間:${date} ${time}

* 項目名稱:${project_name}

* @author daniel

* @version 1.0

* @since JDK 1.6.0_21

* 文件名稱:${file_name}

* 類說明:

*/

${typecomment}

${type_declaration}

${filecomment}

${package_declaration}

/**

* 創建時間:${date} ${time}

* 項目名稱:${project_name}

* @author daniel

* @version 1.0

* @since JDK 1.6.0_21

* 文件名稱:${file_name}

* 類說明:

*/

${typecomment}

${type_declaration}



或者

Java代碼

${filecomment}

${package_declaration}

/**

* Filename: ${file_name}

* Copyright: Copyright (c)2010

* Company: com

* @version: 1.0

* @since: JDK 1.6.0_21

* Create at: ${date} ${time}

* Description:

*

* Modification History:

* Date Author Version Description

* -----------------------------------------------------------------

* ${date} daniel 1.0 1.0 Version

*/

${typecomment}

${type_declaration}

${filecomment}

${package_declaration}

/**

* Filename: ${file_name}

* Copyright: Copyright (c)2010

* Company: com

* @version: 1.0

* @since: JDK 1.6.0_21

* Create at: ${date} ${time}

* Description:

*

* Modification History:

* Date Author Version Description

* ------------------------------------------------------------------

* ${date} daniel 1.0 1.0 Version

*/

${typecomment}

${type_declaration}



二、.jsp 文件部分
---------------------

eclipse-->windows-->preferences-->Web-->JSP Files-->Editer-->Templates-->New JSP File-->單擊[edit]按鈕

在文件首行,添加如下內容:

Java代碼

<%--

創建時間:${date}${time}

創 建 人:daniel

相關說明:

JDK1.6.0_21 tomcat6.0.29 servlet2.5

--%>

<%--

創建時間:${date}${time}

創 建 人:daniel

相關說明:

JDK1.6.0_21 tomcat6.0.29 servlet2.5

--%>

這樣再創建 .java 或 .jsp 文件時,eclipse 就會為我們自動將註釋寫好。你還可以通過“導出”、“導入”功能,把自己的模板導出來,方便在其他機器上使用。

Eclipse自動生成作者、日期註釋等功能設置