1.创建类时,自带类注释。
3处所写 内容。
/**
* TODO
*
* @author ${USER}
* @since ${DATE}
*/
结果如下:
2.定义两套方法模板一套类用,一套方法用。
自定义java方法注释:
第2部位置先创建group,这里叫hozhaMethod。
第3步,在group下创建template。
第4步是设置触发注释的字符。
第5步加解释描述,一会能看到其作用,是为了区分自己创建的两个模板。
第6步的java方法注释模板:
*
* $END$
* $param$ $return$
*/
第7步,设置注释中用到的变量的值,这里涉及到两个脚本如下:
param:
groovyScript( "def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); if(\"${_1}\" != '[]') { result= '\\n '; for(i = 0; i < params.size(); i++) { result+='* @param ' + params[i] + ' ' + ((i < params.size() - 1) ? '\\n ': '') }; }; return result", methodParameters())
return:
groovyScript("def result=\"${_1}\"; if(result == \"void\"){return \"\";}else{return \"\\n * @return {@link \"+result+\"}\";}", methodReturnType())
param脚本可以自动生成所有方法参数,并分行。
return参数可以判断方法返回值,如果是void则改行删掉,否则直接显示method reference.
第8步设置快捷键,这里本人习惯用回车。
第9步,如果没设置过 这里应该是define,点击后勾选everything下的java即可。
自定义java类注释(创建这个是为了给别人新建的没添加注释的类,添加注释):
创建步骤如上更换第六步模板为类的注释模板即可,另外第5步注意更新描述"class annotation", 然后才会产生如下测试效果。
本人idea版本2021.2.2付费版。