Eclipse註釋模板

Eclipse做爲JavaIDE（Integrated Development Environment,集成開發環境）,能夠經過設置自動添加Javadoc註釋信息，如@author 做者名、@version 版本標識、@date 日期等，在建立類或新增方法時會自動添加註釋信息。

@author 做者名

@date 日期

@version 版本標識

@parameter 參數及其意義

@return 返回值

@throws 異常類及拋出條件

@deprecated 引發不推薦使用的警告

@override 重寫

這個註解咱們在java代碼中常常能夠看到。

編輯註釋模板的方法：Window->Preference->Java->Code Style->Code Template

1.文件(Files)註釋標籤：

/**  
 * All rights Reserved, Designed By www.tydic.com
 * @Title:  ${file_name}   
 * @Package ${package_name}   
 * @Description:    描述   
 * @author: Durant2035     
 * @date:   ${date} ${time}   
 * @version V1.0 
 * @Copyright: 
 */  

 

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

/**   
 * @ClassName:  ${type_name}   
 * @Description:${todo}(描述這個類的做用)   
 * @author: Durant2035
 * @date:   ${date} ${time}    
 * ${tags}  
 * @Copyright:  
 */  

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

 在設置模板時若是勾選了自動添加註釋信息，則在建立Java文件時會自動生成文檔和類的註釋信息，若沒有勾選，按Shift+Alt+J快捷鍵也可生成。

 在對類中的方法進行註釋是：在方法上方輸入/** 後點擊回車，便可生成方法註釋；或將光標放在方法名上，按住Shift+Alt+J快捷鍵也可；或在方法上右擊，source》Generate Element Comment也可生成註釋。

註釋模板設置完必定要點擊Appy保存