设置注释模板的入口: Window->Preference->Java->Code Style->Code Template 然后展开Comments节点
以Types为例,Types是类的注释,点击Edit,然后在Pattern中写配置注释。设置完毕后,记得勾选下方的红框标记的勾选框,这样创建方法和类时会自动填充注释了。点击Apply,点击OK。
设置注释时,可以使用下边的Insert Variable中的自动变量,点击变量,会有对应的解释信息。
创建一个测试类,注释自动带出了。
默认快捷键为:ALT + SHIFT +J
想更换为其他的快捷键:Window-->Preferences-->General-->Keys;找到"add javadoc comment"更改自己喜欢的快捷键。
列举一些javadoc标记
标记 | 用于 | 作用 |
@author | 对类的说明 | 标明开发该类模块的作者 |
@version | 对类的说明 | 标明该类模块的版本 |
@exception | 对方法的说明 | 对方法可能抛出的异常进行说明 |
@param | 对方法的说明 | 对方法中某参数的说明 |
@return | 对方法的说明 | 对方法返回值的说明 |