文章目录
- IDEA自定义JavaDOC注释模板
- 方法注释模板
- 1、创建模板
- 2、设置模板内容-JavaDoc格式
- 3、Define
- 4、Edit Variables
IDEA自定义JavaDOC注释模板
JavaDOC注释模板共分为两种：
- 类注释模板
- 方法注释模板
方法注释模板
1、创建模板
File–>Settings–>Editor–>Live Templates
点击 “+” 号，选择 “Template Group” 新建组。然后填写自己定义的组名称，点击“OK”。如下图所示：
选中新建的组，再点击 “+” ，新建"Live Template"。然后填写信息。如下图所示：
注意点：
- Abbreviation填写
* - Expand with 快捷键设置为
Enter
2、设置模板内容-JavaDoc格式
注意：如果您的Abbreviation设置为如上图所示的*,template模板如下面所示：
*
* @description TODO the method is used to
* @author 阿凡达
* @date $time$ $date$ $param$ $return$
*/
3、Define
点击Define按钮（如果是修改则点击change）
弹出的对话框中选择java
4、Edit Variables
注意：必须先进行第三步，再进行第四步
JavaDoc格式的需要自定义参数以及返回值的实现方式:
获取参数实现方式：
groovyScript("def result = '';def params = \"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++) {if(params[i] != '')result+='* @param ' + params[i] + ((i < params.size() - 1) ? '\\r\\n ' : '')}; return result == '' ? null : '\\r\\n ' + result", methodParameters())
返回值实现方式：
groovyScript("return \"${_1}\" == 'void' ? null : '\\r\\n * @return ' + \"${_1}\"", methodReturnType())
如下图：
效果图如下：
