【java基礎】Eclipse Java註釋模板設置詳解以及版權聲明

網上的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: 天源迪科技     
 * @date:   ${date} ${time}   
 * @version V1.0 
 * @Copyright: ${year} www.tydic.com Inc. All rights reserved. 
 * 注意：本內容僅限於深圳天源迪科信息技術股份有限公司內部傳閱，禁止外泄以及用於其餘的商業目
 */

 

 

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

 

/**   
 * @ClassName:  ${type_name}   
 * @Description:${todo}(這裏用一句話描述這個類的做用)   
 * @author: 天源迪科 
 * @date:   ${date} ${time}   
 *   
 * ${tags}  
 * @Copyright: ${year} www.tydic.com Inc. All rights reserved. 
 * 注意：本內容僅限於深圳天源迪科信息技術股份有限公司內部傳閱，禁止外泄以及用於其餘的商業目 
 */

 

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>  
 */