idea 配置java方法注释模板
依次点击File -> Settings -> Editor -> Live Templates
第一步:在Live Templates 右侧点击+
号,添加一个Templates Group,命名为 myTemplate
,如下图:
第二步:在刚刚创建的 myTemplate
下创建一个 Live Templates ,如下图:
第三步:输入注释模板的缩写(Abbreviation),描述(Description),模板内容(Template text)以及选择触发注释模板的按钮(Expand with)
模板内容如下:
**
* <description>
* $param$ $return$
* @throws
* @author bj
* @since 1.0.0 $date$
*/
第四步:配置变量,点击Edit variables
$param$
的值如下:
groovyScript("def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); if(params[0] == ''){return result;}else{result+=\"\\r\\n\"}; for(i = 0; i < params.size(); i++) {result+=' * @param ' + params[i] + ' ' + params[i] + ((i < params.size() - 1) ? '\\r\\n' : '')}; return result", methodParameters())
$return$
的值如下:
groovyScript("def result=\"${_1}\"; if(result == \"void\"){return \"\";}else{return \"\\r\\n * @return {@link \"+result+\"}\";}", methodReturnType())
$date$
的值如下:date()
第五步:更改所选模板的上下文类型
点击下方的change
,或者右键我们定义的模板,如下图所示:
在打开的选项框中勾选可以添加该注释的位置,如下图所示:
第六步:验证效果, 在方法上输入/c
然后按tab
按钮,可以看到如下效果
public class TaskService {
/**
* <description>
*
* @throws
* @author bj
* @since 1.0.0 2021/11/25
*/
public void test() {
}
/**
* <description>
*
* @return {@link List<T>}
* @throws
* @author bj
* @since 1.0.0 2021/11/25
*/
public <T> List<T> test1() {
return null;
}
/**
* <description>
*
* @param params1 params1
* @param params2 params2
* @return {@link List<T>}
* @throws
* @author bj
* @since 1.0.0 2021/11/25
*/
public <T> List<T> test1(T params1, T params2) {
return null;
}
}
注意点:
-
方法模板的内容不能设置成以
/
开头的完整格式,设置成这样会出现检测不到方法参数和返回值,原因未知。例如设置成这样:/** * <description> * $param$ $return$ * @throws * @author bj * @since 1.0.0 $date$ */
出来的效果:
-
@throws
后面的值没法自动生成,暂时未找到方法,需要手动添加。