首先介紹幾個常用的注解:
- @author 作者名
- @date 日期
- @version 版本標識
- @parameter 參數及其意義
- @return 返回值
- @throws 異常類及拋出條件
- @deprecated 引起不推薦使用的警告
- @override 重寫
這個注解我們在java代碼中經常可以看到。
設置注釋模板的步驟:點擊菜單欄上的Window -->Preferences-->Java-->Code Style -->Code Templates,對右側Comments選項中具體的注釋信息進行編輯即可。可勾選上自動添加注釋信息,在生成java文件時便會自動生成注釋,當然也可以手動插入注釋。
下面介紹具體的Comment如何設置:
1. 點擊Comments下的Files可對整個Java文件進行注釋:包括公司名稱,版權所屬,作者信息,日期等。
/**
* <p>Title: ${file_name}</p>
* <p>Description: </p>
* <p>Copyright: Copyright (c) 2017</p>
* <p>Company: www.baidudu.com</p>
* @author shenlan
* @date ${date}
* @version 1.0
*/
-
2. 點擊Types對類進行注釋:
/**
* <p>Title: ${type_name}</p>
* <p>Description: </p>
* @author shenlan
* @date ${date}
*/
3. 點擊Fields對字段進行注釋:
/** ${field}*/
4. 點擊Constructors對構造方法進行注釋:
/**
* <p>Title: </p>
* <p>Description: </p>
* ${tags}
*/
5. 點擊Methods對方法進行注釋:
/**
* <p>Title: ${enclosing_method}</p>
* <p>Description: </p>
* ${tags}
*/
6. 點擊Overriding Methods對重寫方法進行注釋:
/* (non-Javadoc)
* <p>Title: ${enclosing_method}</p>
* <p>Description: </p>
* ${tags}
* ${see_to_overridden}
*/
7. Delegate methods對代表方法進行注釋:
/**
* ${tags}
* ${see_to_target}
*/
8. Getters對get方法進行注釋:
/**
* @return the ${bare_field_name}
*/
9. Setters對set方法進行注釋:
/**
* @param ${param} the ${bare_field_name} to set
*/
注解使用的方法:
在對類中的方法進行注釋是:在方法上方輸入/** 后點擊回車,即可生成方法注釋;或將光標放在方法名上,按住Shift+Alt+J快捷鍵也可;或在方法上右擊,source》Generate Element Comment也可生成注釋。