IDEA 生成类注释和方法注释

目录

• 一、生成类注释-01
  • 1.1、生成类注解模板
  • 1.2、把模板设置到IDEA中
  • 1.3、效果图
• 二、生成类注释-02
  • 2.1、生成类注释模板
  • 2.2、把模板设置到IDEA中
  • 2.3、效果图
  • 2.4、在 Interface 和 Enum 中添加
• 三、两种类注释生成的区别
• 四、生成方法注释
  • 4.1、生成方法注释模板
  • 4.2、把注释模板设置到IDEA中
  • 4.3、效果图

一、生成类注释-01

1.1、生成类注解模板

/**
 * @ClassName ${NAME}.java
 * @author 创建人名称
 * @version 1.0.0
 * @Description TODO
 * @createTime ${YEAR}年${MONTH}月${DAY}日 ${HOUR}:${MINUTE}
 */

1.2、把模板设置到IDEA中

依次打开 File -> Settings -> Editor -> File and Code Templates -> Includes -> File Header

1.3、效果图

二、生成类注释-02

2.1、生成类注释模板

/**
* @ClassName ${NAME}.java
*
* @Description ${description}
*
* @author 作者名称
*
* @createTime ${YEAR}-${MONTH}-${DAY} ${HOUR}:${MINUTE}
**/

2.2、把模板设置到IDEA中

2.3、效果图

2.4、在 Interface 和 Enum 中添加

三、两种类注释生成的区别

第一种在 Includes 的 File Header 里面创建的，类注释创建类完成后修改。

第二种在 File 的 Class 里面创建的，会在每次创建类的时候弹窗，输入的内容就是注释的内容。

四、生成方法注释

4.1、生成方法注释模板

/**
 * @description TODO
 * @author F.石榴
 * @param $param$
 * @createTime $date$ $time$
 * @return $return$
 */

4.2、把注释模板设置到IDEA中

File -> Setting -> Preferences -> Editor -> Live Templates -> 点击右边加号为自己添加一个Templates Group -> 然后选中自己的 Group 再次点击加号添加 Live Templates

勾选所有即可

params值：

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

4.3、效果图

原文链接：https://mp.weixin.qq.com/s/Gc_79xbbba7PS_3Rzfs6Uw