idea添加注释模板(记录)

1. 在file选项下选中settiing,如下图所示:

注:本文参考博客地址为:https://www.cnblogs.com/pypua/p/11048022.html

2. 在 editor选项下选择 Live Templates,如下图所示:

3. 新建组:命名为custom

 

4. 新建模板:命名为*

因为IDEA生成注释的默认方式是:模板名+快捷键(比如若设置模板名为*快捷键用Enter,则生成方式为

*+空格),如果不采用这样的生成方式IDEA中没有内容的方法将不可用,例如获取方法参数的methodParameters()、

获取方法返回值的methodReturnType()

 

5 设置生成注释的快捷键

 

6 设置模板:模板内容如下

在设置参数名时必须用${参数名}$的方式,否则第五步中读取不到你设置的参数名

/**
 * @description: 
 * @author: $user$
 * @time: $date$ $time$
 $params$
 * @return: $return$
 */ 

7 设置模板的应用场景

点击模板页面最下方的警告,来设置将模板应用于那些场景,一般选择EveryWhere-->Java即可

(如果曾经修改过,则显示为change而不是define)

8 设置参数的获取方式

选择右侧的Edit variables按钮

选择每个参数对应的获取方法(在下拉选择框中选择即可),网上有很多教程说获取param时使用脚本的方式,我试过使用脚本

的方式不仅麻烦而且只能在方法内部使用注释时才能获取到参数

其中params变量的内容一定要放在Default value中!!!内容为:

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

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值