阿里巴巴编程规范插件中需要你在接口方法上使用javadoc注释,手写的话太麻烦,但是我们可以通过idea设置一个方法注释模板,用来快捷生成方法注释,本文章主要分享的是自动生成参数的模板。
如图,接口方法需要使用javadoc注释。
Alt+Shift+S 打开设置,找到 Editor > Live Templates
点击旁边的加号,选择 Template Group... 添加一个模板分组,我新建的是CUSTOM
然后在这个组里添加一个模板
如图这是我设置的模板
Abbreviation - 模板缩写(随便写,当你敲出这个缩写时就会自动输入注释了)
Description - 模板描述 (随便写,是idea提示框上这个缩写代码的描述)
Template text - 模板主体内容,$$代表动态变量,用来读取需要注释的方法的内容,下文描述
按钮:Edit variables - 配置动态变量,下文描述
这里我先把模板分享给大家:
**
* $description$$params$
* @return $returns$
* @create $date$ $time$
*/
Edit variables 动态变量配置:
第一个Name就是你$$里的内容
Expression是表达式,可以使用一些默认函数,比如我returns,date,time,如图写就可以自动生成方法返回值和日期时间
DefaultValue是默认值,如图params我写的是脚本,是我从网上搜索然后加以修改的自动生成方法参数的脚本
最后一项如果取消勾选生成后就不会自动选中让你编辑内容,如图我的description就是没有勾选,注释生成后就会光标就回到description后面让我输入内容
脚本代码如下:
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()
)