IDEA注释模板设置（超详细-类和方法）
#配置#Java
首先先上效果
- JAVA类或者接口创建时自动模版生成
- 接口方法注解模版自动生成，包含参数和返回值的自动解析
- 接口方法文档doc标注自动生成，包含参数和返回值的自动解析
- 自动生成后，自动光标停留在描述行，并有TODO标注，方便描述丝滑添加
1. JAVA类、接口IDEA模版配置
- 配置项路径：
File-->settings-->Editor-->File and Code Templates-->Files - 选择Class文件（设置接口则选择Interface文件）
${NAME}：设置类名，与下面的${NAME}一样才能获取到创建的类名TODO：代办事项的标记，一般生成类或方法都需要添加描述${USER}、${DATE}、${TIME}：设置创建类的用户、创建的日期和时间，这些是IDEA内置的方法，还有一些其他的方法在右下方描述框中有详细讲述（虽然是英文），比如你想添加项目名则可以使用${PROJECT_NAME}- 设置版本号，一般新创建的类都是1.0.0版本，这里写死，自行修改
1. 效果：
2. 配置图示：
3. 配置示例代码：
TXT
/**
* @ClassName ${NAME}
* @Description // TODO: $end
* @Author ${USER}
* @Date ${DATE} ${TIME}
* @Version 1.0.0
*/2. 方法注解模版配置
- 配置项路径：
File-->settings-->Editor-->Live Templates - 新建组：命名为
UserDevGroup - 如下述具体步骤配置，设置生成注释的快捷键为Enter，都配置好后点击OK保存
1. 效果：
2. 配置图示：（配置成 *）
1. 配置项关键路径，创建自定义模版组 UserDevGroup
2. 新建一个方法模版
3. 设置方法模版，并应用配置（一定要应用，或者点OK保存配置变更）
4. 配置变量对应的扩展方法（用于IDEA自动获取数据）
5. 配置应用范围为JAVA项的树列表，并点击OK保存配置
3. 配置示例代码：（注意第一行是* 而不是完整的/**）
TXT
**
* @description // TODO: $end$
* @author lf
* @date $time$ $date$
* @param $param$
* @return $return$
**/命名为*
因为IDEA生成注释的默认方式是：/*+模板名+快捷键
比如若设置模板名为add快捷键用Tab，则生成方式为/*add+Tab
如果不采用这样的生成方式IDEA中没有内容的方法将不可用，例如获取方法参数的methodParameters(）、获取方法返回值的methodReturnType(）
3. 方法文档doc标注模版配置
- 配置项路径：
File-->settings-->Editor-->Live Templates - 新建组：命名为
UserDocGroup - 如下述具体步骤配置，设置生成注释的快捷键为Enter，都配置好后点击OK保存
1. 效果：
2. 配置图示：（doc配置成 **）
1. 配置图示：
2. 变量配置：
3. 同样地，还需要Change应用范围为JAVA项树列表，并点击OK保存
3. 配置示例代码：（注意第一行是* 而不是完整的/**）
- template示例代码：
TXT
**
* @description // TODO: $end$
* @author lf
* @date $time$ $date$ $param$ $return$
**/- param获取脚本
SCRIPT
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())- return获取脚本
SCRIPT
groovyScript("return \"${_1}\" == 'void' ? null : '\\r\\n * @return ' + \"${_1}\"", methodReturnType())
加载评论中...