IDEA自定义配置注释模板,让你看起来更加专业!!!

一:类注释

我们先来康康成果:

在以上的代码中我们可以看到只要创建一个类,idea自动会给你补充注释消息,有作者信息和创建时间
关于模板参数代码我已经放到下面了:

/**
 *@author: dlwlrma
 *@data ${YEAR}年${MONTH}月${DAY}日 ${TIME}
 */

 使用方法:

打开IDEA的Settings,点击Editor-->File and Code Templates,点击右边File选项卡下面的Class,在其中添加上述代码注释就OK了

二:方法注释

先来康康成果

 在方法上面我们是可以根据参数的类型和有无返回值来定义注释的

具体过程如下:

首先点击Settings中点击Editor-->Live Templates 点击最右边的 +,

首先选择 2. Template Group... 来创建一个模板分组:

在弹出的对话框中填写分组名,我这里叫做 userDefine

然后选中刚刚创建的模板分组 userDefine,然后点击 +,选择 1. Live Template:

创建模板

此时就会创建了一个空的模板,我们修改该模板的 Abbreviation、Description 和 Template text。需要注意的是,Abbreviation 必须为 * ,最后检查下 Expand with 的值是否为 Enter 键。

点击 Define,在弹框中勾选Java,表示将该模板应用于所有的 Java 类型文件。

设置 applicable contexts

还记得我们配置 Template text 时里面包含了类似于 $date$ 这样的参数,此时 IDEA 还不认识这些参数是啥玩意,下面我们对这些参数进行方法映射,让 IDEA 能够明白这些参数的含义。点击 Edit variables 按钮。

需要注意的是,date 和 time 的 Expression 使用的是 IDEA 内置的函数,直接使用下拉框选择就可以了,而 param 和return 需要我们自己来实现。

Template text 内容如下:

*
 *
 * @author dlwlrma
 * @date $date$ $time$$param$ $return$
 */

 

param中的参数有:

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

 return中的参数有:

groovyScript("return \"${_1}\" == 'void' ? null : '\\r\\n * @return ' + \"${_1}\"", methodReturnType()

之后点击OK,就大功告成了!!!

评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值