IDEA 注释模板,惊艳了!动作要快,姿势要帅!
Java资料站
共 2760字,需浏览 6分钟
·
2021-11-18 10:51
点击上方蓝色字体,选择“标星公众号”
优质文章,第一时间送达
一、类注释
Settings
,点击 Editor-->File and Code Templates
,点击右边 File
选项卡下面的Class
,在其中添加图中红框内的内容:/**
* @author jitwxs
* @date ${YEAR}年${MONTH}月${DAY}日 ${TIME}
*/
Description
中被列出来。Interface
项即可。二、方法注释
根据形参数目自动生成 @param
注解根据方法是否有返回值智能生成 @Return
注解
Settings
中点击 Editor-->Live Templates
。+
,首先选择 2. Template Group...
来创建一个模板分组:userDefine
,然后点击 +
,选择 1. Live Template
:Abbreviation
、Description
和 Template text
。需要注意的是,Abbreviation
必须为 *
,最后检查下 Expand with
的值是否为 Enter 键。Template text
内容如下,请直接复制进去,需要注意首行没有 /
,且 \*
是顶格的。*
*
* @author jitwxs
* @date $date$ $time$$param$ $return$
*/
No applicable contexts yet
了吗,这说明此时这个模板还没有指定应用的语言:Define
,在弹框中勾选Java
,表示将该模板应用于所有的 Java 类型文件。Template text
时里面包含了类似于 $date$
这样的参数,此时 IDEA 还不认识这些参数是啥玩意,下面我们对这些参数进行方法映射,让 IDEA 能够明白这些参数的含义。点击 Edit variables
按钮:Expression
:date
和 time
的 Expression
使用的是 IDEA 内置的函数,直接使用下拉框选择就可以了,而 param
这个参数 IDEA 默认的实现很差,因此我们需要手动实现,代码如下: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())
注:你还注意到我并没有勾选了 Skip if defined
属性,它的意思是如果在生成注释时候如果这一项被定义了,那么鼠标光标就会直接跳过它。我并不需要这个功能,因此有被勾选该属性。
三、检验成果
3.1 类注释
3.2 方法注释
无形参 单个形参 多个形参 无返回值 有返回值
四、Q & A
Abbreviation
一定要叫 \*
?Expand with
要保证是 Enter 键?模板名 + 生成键
,当生成键是 Enter 时,我们输入 * + Enter
就能够触发模板。*
了,因为当我们先输入 /*
,然后输入 * + Enter
,触发模板,首行正好拼成了 /**
,符合 Javadoc 的规范。\*
?$time$$param$
这两个明明不相干的东西为什么紧贴在一起?@param
,因此我对param 函数的代码进行修改,使得在无参情况下不生成 @param
,但是这就要求 $param$
要和别人处在同一行中,不然没法处理退格。methodReturnType()
, 而要自己实现?methodReturnType()
在无返回值的情况下会返回 void,这并没有什么意义,因此我对 methodReturnType() 返回值进行了处理,仅在有返回值时才生成。$return$
不是单独一行?methodReturnType()
返回 null 时,无法处理退格问题,原因同第三点。加锋哥微信: java3459 围观锋哥朋友圈,每天推送Java干货!
评论