其实网上很多设置类注释的地方,所以具体步骤就不写了。主要写今天碰到的几个问题吧。
标题
1、关于设置methodParameters() 不生效问题:
所有现在博文有两种,一种是使用methodParameters(),一种是使用一行脚本,脚本问题2贴。 不知道是不是我idea版本问题,我直接快捷键+tab出来,@param出来总是空的,各种测试以后,发现先输入/,然后快捷键+tab出来就对了。或者先输入/+快捷键,然后tab,注释就出来了.简单来说就是/+快捷键+tab。也就是必须配合/使用,出来的注释的methodParameters才不是空。但是这样导致结果就是自动生成的配置多了/,所以配置的注释里面,不需要/,也就是直接**开头
2、多个param,数组显示,而不是每个一行显示,解决方式如下:
params不要直接使用methodParameters(),使用如下配置:
groovyScript("def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++) {result+='* @param: ' + params[i] + ((i < params.size() - 1) ? '\\n ' : '')}; return result", methodParameters())
3、生成的注解缩进有问题:
如果缩进有问题,调整上面 \n后面的空格数量。或者* @param:前面的空格,其实就是脚本里面空格数不太对,稍微调整一下空格数即可。
4、生成的注解,加上注释以后,格式会变一下:
在配置界面勾上reformat according to style
4、生成注解里面参数有报错:@param *** tag description is missing
其实是@param后面缺少了:,不需要甚至javadoc的告警级别。加上:就行了。如下图filepath就没错,interfaceFile就有那个告警。加上:就好了
综上,下面是我的配置,我这么配置的原因就是解决上面的问题。
**
* @Description: $description$
* @author: lvly
* @date: $date$ $time$
$params$
* @return: $returns$
* @throws:
*/
params配置:
groovyScript("def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++) {result+='* @param: ' + params[i] + ((i < params.size() - 1) ? '\\n ' : '')}; return result", methodParameters())
我设置的快捷键是q,所以我输入/q 然后点击tab,出现注释如下:
|