idea注释模板开发配置
- Class⽂件头部注释配置
- ⽅法注释配置
Class⽂件头部注释配置
打开IDEA配置窗⼝
选择 Editor -> File and Code Templates
在选项卡中的 include 的 File Header 中输⼊以下内容:
/**
*
* @author 作者名称(按照自己名称进行定义)
* @date ${YEAR}-${MONTH}-${DAY}
* @since 1.0
**/
⽅法注释配置
打开IDEA配置窗⼝
选择 Editor -> Live Templates
点击右侧窗⼝的 + 选择 2.Template Group
在弹出的窗体中输⼊ user （也可⾃⾏定义其他名称）
点击右侧窗⼝的 + 选择 1.Live Template
在 Abbreviation 输⼊框中输⼊模版触发字符串 *
在 Description 输⼊框中输⼊描述 Java注释模版
在 Template text: 输⼊框中输⼊以下配置：
*
$params$
$returns$
* @author 作者名称(按照自己名称进行定义)
* @date $date$ $time$
* @since 1.0.0
**/
点击在配置框下部的蓝⾊的 Define ，在弹出的选择框中选择 Java 选项中的所有⼦项标识此
模版只在Java代码中⽣效
右侧配置框中 Options ⾥⾯选中以下2项:
- Reformat according to style
- Expand With 选择 Enter
注意：点击配置框右侧的 EDIT VARIABLES 按钮在弹出的数据框中可以看到所有的需要配置的变量。font>
依次对变量进⾏配置：
desc 在 Expression 输⼊框中选择 methodName() 代表此变量使⽤内置的⽅法名作为⽅法描述
params 在 Expression 输⼊框中输⼊以下的表达式代表⽅法参数使⽤以下脚本⽣成
groovyScript("def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++) {result+=' * @param ' + params[i] + ((i < params.size() - 1) ? '\\r\\n' : '')}; return result", methodParameters())
returns 在 Expression 输⼊框中输⼊以下的表达式代表⽅法返回值使⽤以下脚本⽣成
groovyScript("def returnType = \"${_1}\"; if(returnType == 'null' || returnType == '') return '\\b';def result = '* @return ' + returnType; return result;", methodReturnType())
date 在 Expression 输⼊框中选择 date() 代表此变量使⽤内置的⽇期函数
time 在 Expression 输⼊框中选择 time() 代表此变量使⽤内容的时间函数
使⽤⽅法在Java⽅法上输⼊ /* + 回⻋ 即可
