idea方法模板注释，完美解决param与return

待我称王封你为后i 2022-10-21 14:50 253阅读 0赞

#### 完美解决@param与@return ####

idea自带的/\*\*注释是不能自定义作者，日期等信息的，如果需要可以采用以下这种方式  
**先自定义一个模板**

![在这里插入图片描述][20210505131825752.png]

*
     * $END$$params$$return$
     * @author XXX
     * @date $date$ $time$
     */

接下来自己定义变量

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3pfc3N5eQ_size_16_color_FFFFFF_t_70]

params定义脚本为

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

return的定义脚本为

groovyScript("if(\"${_1}\" == 'void') {return ;} else { def returnType = \"${_1}\"; def result = '\\n * @return ' + returnType; return result;}", methodReturnType());

结果为  
![在这里插入图片描述][20210505132334551.png]

[20210505131825752.png]: /images/20221021/b49e7d22a67d47d09fc472ba87c4a07f.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3pfc3N5eQ_size_16_color_FFFFFF_t_70]: /images/20221021/951eedda03644c6385910baec0863e13.png
[20210505132334551.png]: /images/20221021/8e79fc1a41ec4236b42337f109658644.png