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保存