1. 程式人生 > >Eclipse Java註釋和程式碼模板設定詳解

Eclipse Java註釋和程式碼模板設定詳解

參考:http://www.cnblogs.com/senzjx/archive/2009/09/21/1570950.html

1、設定註釋模板的入口: Window->Preference->Java->Code Style->Code Template 然後展開Comments節點就是所有需設定註釋的元素啦。設定完成之後,通過按鈕“Export All...”可以把設定好的模版匯出,然後在其他機器上通過“Import...”匯入

2、雙擊對應型別即可以編輯,或者點選按鈕“Edit...”,可以通過介面的"Insert Variable..."按鈕來插入豐富的型別資料。

3、該介面除了有註釋模版(Comments),還有程式碼模版(Code)

一下是一個Comments的例子:

現就每一個元素逐一介紹:

檔案(Files)註釋標籤:

/**   
* @Title: ${file_name} 
* @Package ${package_name} 
* @Description: ${todo}(用一句話描述該檔案做什麼) 
* @author A18ccms A18ccms_gmail_com   
* @date ${date} ${time} 
* @version V1.0   
*/

型別(Types)註釋標籤(類的註釋):

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

* ${tags} 
*/

欄位(Fields)註釋標籤:

/** 
* @Fields ${field} : ${todo}(用一句話描述這個變量表示什麼) 
*/ 
建構函式標籤:

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

方法(Constructor & Methods)標籤:

/** 
* @Title: ${enclosing_method} 
* @Description: ${todo}(這裡用一句話描述這個方法的作用) 
* @param ${tags}    設定檔案 
* @return ${return_type}    返回型別 
* @throws 
*/

覆蓋方法(Overriding Methods)標籤:

/* (非 Javadoc) 
* <p>Title: ${enclosing_method}</p> 
* <p>Description: </p> 
* ${tags} 
* ${see_to_overridden} 
*/

代表方法(Delegate Methods)標籤:

/** 
* ${tags} 
* ${see_to_target} 
*/ 
getter方法標籤:

/** 
* @return ${bare_field_name} 
*/

setter方法標籤:

/** 
* @param ${param} 要設定的 ${bare_field_name} 
*/

下面這個是Code的一個簡單例子

例如:New Java files

/*******************************************************************************
 * @project: ${project_name}
 * @package: ${package_name}
 * @file: ${file_name}
 * @author: ${user}
 * @created: ${date}
 * @purpose:
 * 
 * @version: 1.0
 * 
 * Revision History at the end of file.
 * 
 * Copyright ${year} AcconSys All rights reserved.
 ******************************************************************************/


${filecomment}
${package_declaration}


${typecomment}
${type_declaration}


/*******************************************************************************
 * <B>Revision History</B><BR>
 * [type 'revision' and press Alt + / to insert revision block]<BR>
 * 
 * 
 * 
 * Copyright ${year} AcconSys All rights reserved.
 ******************************************************************************/