idea自定义类注释模板和方法注释模板,并完美解决空参数,无返回值的方法注释模板

修改idea自带类注释模板

进入设置File->Settings

修改自带类注释

5下面的红框是可用参数.因为${USER}不好用,我这里直接设置的作者,没有使用参数形式

/**
 * TODO
 *
 * @author fan
 * @date ${DATE}
 */

应用模板.这一步基本不用改,自带的就是这样.

测试.创建新类注释按照模板方式自动添加

自定义方法,类注释版本

进入设置File->Settings

创建模板组

输入名称,保存

创建模板

输入模板参数

说明

• 1和7是注释的组合快捷键,在**后按制表符Tab会触发该注释
• 4弹出框中输入5的内容,6保存

第3步内容

**
 * TODO
 *
 * $params$
 * $return$
 * @author $user$
 * @date $date$
 */

第5步中方法参数params内容

groovyScript("def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList();def length=params[0].length();if(length > 0){for(i = 0; i < params.size(); i++) {if(i>0){result+=' * '};result+='@param ' + params[i] + ((i < params.size() - 1) ? '\\n':'')}}; return result", methodParameters()) 

第5步返回值return内容(我这里是如果有返回值有添加@return)

groovyScript("def result=''; def returnType=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '');if('void'!=returnType){result='@return '};return result", methodReturnType()) 

有些人想添加@return 返回值类型;如下

groovyScript("def result=''; def returnType=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '');if('void'!=returnType){result='@return ' + returnType};return result", methodReturnType())

应用模板

勾选后效果图

再添加一个模板(应用模板和上面的一样)

如果添加模板,模板之间的abbreviation不能一样

测试

类注释设置的abbreviation(缩写)和Expand with是*和Tab

效果

方法注释设置的abbreviation(缩写)和Expand with是**和Tab

效果

美中不足.无参或者无返回值仍会占用一行注释