IDEA 注释模板,这样配置才够逼格!
阅读本文大概需要 3.5 分钟。
来自:https://jitwxs.cn/4135e0a9.html
一、类注释
/**
* @author jitwxs
* @date ${YEAR}年${MONTH}月${DAY}日 ${TIME}
*/
二、方法注释
根据形参数目自动生成 @param
注解根据方法是否有返回值智能生成 @Return
注解
2. Template Group...
来创建一个模板分组:1. Live Template
:需要注意的是,Abbreviation 必须为 *
,最后检查下 Expand with 的值是否为 Enter 键。
Template text
内容如下,请直接复制进去,需要注意首行没有 /
,且 *
是顶格的。*
*
* @author jitwxs
* @date $date$ $time$$param$ $return$
*/
No applicable contexts yet
了吗,这说明此时这个模板还没有指定应用的语言:Template text
时里面包含了类似于 $date$
这样的参数,此时 IDEA 还不认识这些参数是啥玩意,下面我们对这些参数进行方法映射,让 IDEA 能够明白这些参数的含义。点击 Edit variables
按钮: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())
groovyScript("return \"${_1}\" == 'void' ? null : '\\r\\n * @return ' + \"${_1}\"", methodReturnType())
注:你还注意到我并没有勾选了 Skip if defined 属性,它的意思是如果在生成注释时候如果这一项被定义了,那么鼠标光标就会直接跳过它。我并不需要这个功能,因此有被勾选该属性。
三、检验成果
3.1 类注释
3.2 方法注释
无形参 单个形参 多个形参 无返回值 有返回值
四、Q & A
* ?Expand with
要保证是 Enter 键?* + Enter
就能够触发模板。*
了,因为当我们先输入 /*
,然后输入 * + Enter
,触发模板,首行正好拼成了 /**
,符合 Javadoc 的规范。*
?$time$$param$
这两个明明不相干的东西为什么紧贴在一起?@param
,因此我对param 函数的代码进行修改,使得在无参情况下不生成 @param
,但是这就要求 $param$
要和别人处在同一行中,不然没法处理退格。methodReturnType()
, 而要自己实现?methodReturnType()
在无返回值的情况下会返回 void,这并没有什么意义,因此我对 methodReturnType()
返回值进行了处理,仅在有返回值时才生成。$return$
不是单独一行?methodReturnType()
返回 null 时,无法处理退格问题,原因同第三点。推荐阅读:
Spring Boot 一个接口同时支持 form 表单、form-data、json 的优雅写法
互联网初中高级大厂面试题(9个G) 内容包含Java基础、JavaWeb、MySQL性能优化、JVM、锁、百万并发、消息队列、高性能缓存、反射、Spring全家桶原理、微服务、Zookeeper......等技术栈!
⬇戳阅读原文领取! 朕已阅
评论