目的:针对含有多个参数的方法,在方法外可以根据设置的快捷键,生成相应方法注释。
类注释,网上教程很多。随意搜索即可。这里主要讲解下,方法前添加注释的操作。
之前按照网上的教程,设置了很多遍,但依旧不能实现想要的效果。
根据网上的教程,在设置时出现过以下问题:
1、只能在方法内,通过设定好的快捷键,生成带有多个参数的方法注释。方法外,生成注释,参数项获取不到参数,显示为null。
2、生成的注释,部分行排版存在问题,无法对齐。
设置时,主要操作节点
自定义params参数值:
网上有很多参数可参照,这里做了相应优化。
groovyScript("def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++) {result+= ((i==0)?'* @param: ':' * @param: ') + params[i] + ((i < params.size() - 1) ? ' \\n' : ' ')};return result", methodParameters())
- 以下为效果错误时的图示
导致以上显示问题的原因:params参数添加在了 Expressions中。
- 以下为正确的设置
正确显示的原因:params参数添加在了 Default Value 中。
- 设置return
设置return时,使用Expression中的默认函数 methodReturnType(),将会在生成注释时,返回全类名。
如想要不显示全类名,可按如下配置。
groovyScript("def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split('<').toList(); for(i = 0; i < params.size(); i++) {if(i!=0){result+='<';}; def p1=params[i].split(',').toList(); for(i2 = 0; i2 < p1.size(); i2++) { def p2=p1[i2].split('\\\\.').toList(); result+=p2[p2.size()-1]; if(i2!=p1.size()-1){result+=','} } ; }; return result", methodReturnType())
至此,多参数方法对应注释设置完成。
至于为何将params值添加在Default Value中,显示正常,添加在Expressions中,显示不正常的原因,还不清楚。
烦请各位路过大神解惑。不胜感激!