IDEA注释模板配置

类注释

IDEA中在创建类时会自动给添加注释的方法：

File–>settings–>Editor–>File and Code Templates

还有一些其他用法可以翻译一下右下角的Description框子里面的内容

/**
  * @ClassName ${NAME}
  * @Description TODO
  * @Author ${USER}
  * @Date ${YEAR}-${MONTH}-${DAY} ${HOUR}:${MINUTE}:${SECOND}
  **/

新建类可以发现直接带了注释

设置方法注释模板

有个习惯   /*+Enter 直接生成注释，这里我们直接按着习惯设置IDEA的方法注释

File–>Settings–>Editor–>Live Templates

新建组：

组名称可以随意些

同样的方法新建模板

By default expand with **  这里选Enter

Abbreviation（名称）填*号，Description（注释）随意写

2、点击Edit variables 

因为date()和time()函数显示出来的日期时间格式会很莫名其妙，所以得这么改：

time     time(“HH:mm:ss”)

date     date(“yyyy/MM/dd”)

param     methodParameters()

return     methodReturnType()

效果图：

参数不堆叠方式（ 快捷键 /* + Enter ）

**
 * $end$
 * @param $params$
 * @throws $throws$
 * @Author: JG
 * @Date: $date$ $time$
 * @return: $return$
 */

param表达式：

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

return表达式：

groovyScript("def returnType = \"${_1}\"; def result = '* @return: ' + returnType; return result;", methodReturnType());  

最终 ctrl+alt+l  格式化后的样式：（可以通过阿里巴巴代码规范的插件[Alibaba Java Coding Guidelines]检测）

/**
 * 此处填写描述
 *
 * @param a 
 * @param  b 
 * @throws Exception
 * @Author: JohnGene
 * @Date: 2021/06/24 11:16:25
 * @return: java.lang.String
 */