Eclipse自動添加註釋模板

標籤：

 

Eclipse使用自動注釋：在Eclipse工具的Window\preferences\JAVA\Code Style\Code templates\Comments下設定以下模版

 

檔案(Files)注釋標籤

/** * @Title: ${file_name} * @Package: ${package_name} * @Description: ${todo}(用一句話描述該檔案做什麼) * @author: ${user} * @date: ${date} ${time} * @最後修改人: ${user} * @最後修改時間: ${date} ${time} * @version: V1.0 * @copyright: ASIAINFO */

　　特別說明：關於“${user}”配置，如果想配置成自己自訂的姓名，如：張三，則需要在eclipse/myeclipse的目錄下找到eclipse.ini/myeclipse.ini檔案，在-vmargs後邊添加上啟動參數：-Duser.name=張三，並重啟myeclipse工具後“* @author ${user}”將改變為“* @author  張三”。

 

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

/**     * @ClassName: ${type_name}  * @Description: ${todo}(這裡用一句話描述這個類的作用)  * @author: ${user} * @date: ${date} ${time} * @最後修改人: ${user} * @最後修改時間: ${date} ${time} * ${tags} */

 

欄位(Fields)注釋標籤

/** * @Description: ${todo}(這裡用一句話描述這個類的作用)  * @Fields: ${field} */

 

建構函式標籤

/** * @Title: 建構函式 * @Description: (描述建構函式實現的功能) * ${tags} */

 

方法(Constructor & Methods)標籤

/**     * @Title: ${enclosing_method}  * @Description: ${todo}(這裡用一句話描述這個方法的作用)  * @最後修改人: ${user} * @最後修改時間: ${date} ${time} * ${tags} 對方法的參數進行描述 * @return: ${return_type} 傳回型別 * @throws */

 

覆蓋方法(Overriding Methods)標籤

/**      * @Title: ${enclosing_method} * @Description: ${todo}(這裡用一句話描述這個方法的作用) * @最後修改人: ${user} * @最後修改時間: ${date} ${time} * ${see_to_overridden} * ${tags} 對方法的參數進行描述 * @throws */

 

代理方法(Delegate Methods)標籤

/**     * @Title: ${enclosing_method}  * @Description: ${todo}(這裡用一句話描述這個方法的作用)  * @最後修改人: ${user} * @最後修改時間: ${date} ${time} * ${see_to_target} * ${tags} 對方法的參數進行描述 * @throws */

 

getter方法標籤

/**     * @Title: 返回 ${bare_field_name} 的值   * @return ${bare_field_name} */

 

setter方法標籤

/**     * @Title: 設定 ${bare_field_name} 的值 * @param ${param} 參數設定變數 ${bare_field_name} 的值 */

 

　　設定完成之後，可以輸入/**然後斷行符號就可以自動添加註釋了。

 

Eclipse自動添加註釋模板