本文主要介绍java类注释和方法注释自定义模板,让你不再每次手写javadoc
1、任务栏顶部File->Settings

2、进入Settings页后,Editor->Live Tempaltes->Template Group...,新增一个模板组,模板组名称随便写,自己记得这个模板组是干嘛的就行,我本地叫user

3、自定义注释:选中刚刚新建的模板组,新增一个动态模板(Live Tempalte)

4、自定义类注释:修改缩写叫 * ,描述随便写,我这里叫类注释,在模板文本中粘贴如下内容后编辑变量
** * @description TODO * @author zhangsan * @date $date$ */

5、变量date的表达式选择idea自带的date()方法,且要勾选后面的Skip if defined(注意:我此处时间格式为yyyy-MM-dd,如果想要时间格式为yyyy-MM-dd HH:mm:ss,在刚刚的文本$date$后加上$time$,并在编辑变量页面中,选择变量time的表达式为idea自带的time()方法,且要勾选后面的Skip if defined)

6、所有的设置完后,还有两步操作,第一个就是展开方式选择Enter,也可以选择其他,根据自己的习惯(此处的处理就是注释是按什么键去触发你这个类注释模板);第二个就是适用语言和应用场景,Define 或 Change,选择 Java -> comment,如果不勾选,模板会不生效


7、类注释的演示:输入 /* 然后按你刚刚第6步设置的展开方式,比如Enter键
下面展示不勾选Skip if defined的效果

下面展示勾选Skip if defined的效果

8、自定义方法注释:新增一个Live Tempalte,修改缩写叫 ** ,描述随便写,我这里叫方法注释,在模板文本中粘贴如下内容后编辑变量
** * @description TODO$params$ $returns$ * @author zhangsan * @date $date$ */

9、变量params、returns表达式处理如下,date处理方式跟类注释一样(注意:勾选后面的Skip if defined)
变量params表达式
groovyScript("def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++) {if(params[i] != '')result+='\\n * @param ' + params[i] + ((i < params.size() - 1) ? '' : '')}; return result", methodParameters())
变量returns表达式
groovyScript("def returnType = _1; return (returnType == 'void' || returnType == null) ? '' : '\\n * @return ' + returnType;", methodReturnType())

设置完后的两步操作跟类注释一样

10、方法注释的演示:输入 /** 然后按你刚刚第6步设置的展开方式,比如Enter键

夜雨聆风