IDEA设置注释模板

615 阅读2分钟

前言

我的idea是2020.2-Mac版,其他版本我不确定是否生效,因为网上一些教程方法对我的idea没有效果

本文主要介绍类注释模板和函数注释模板,其实idea还可以做很多模板比如日志、固定规则的代码等。

正文

类模板

在类创建成功的时候会自动生成

image.png 可以看到创建Class时引入了一个参数"File Header.java",对应的是Files旁边的Includes→File Header文件,File Header里就是创建类时的注释模板,下面Description中有描述一些可以配置的参数,可以根据自己需要选用。

image.png

注释内容如下

/**
 * @className ${NAME}.java
 * @author tong.li
 * @description TODO
 * @createTime ${YEAR}年${MONTH}月${DAY}日 ${HOUR}:${MINUTE}:00
 */

函数模板

1、创建模板组

image.png

2、创建模板

image.png

3、编辑模板

image.png 下边按照序号一个个讲解

3.1、快捷键生成方式配合使用生成注释,图片里表达的生成注释的方式:输入*,然后按Tab

3.2、功能描述,自己定义即可

3.3、注释内容,如果生成出来格式有问题,自己微调即可,比如我这里给出的注释缺少/,因为我自己习惯用/*起手输入注释,所以我在给函数添加注释的时候会输入:/*+Tab

*
 * @title: $title$
 * @description:
 $param$
 * @return $return$
 * @author tong.liu
 * @date $date$ $time$
*/

3.4、模板作用域,即适用范围,比如只选java或者全部都生效:点击Define然后选择作用域

image.png

3.5、快捷键生成方式配合使用生成注释,图片里表达的生成注释的方式:输入*,然后按Tab

5.6、变量函数,需要给变量(模板内容里边的带$的)计算值的函数表达式

image.png

  • param和return比较特殊,其他的使用idea内置表达式就可以了
// param
groovyScript("def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++) {result+='* @param: ' + params[i] + ((i < params.size() - 1) ? '\\n ' : '')};return result", methodParameters())  

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

步骤都走完了后保存然后测试看下结果

测试

类注释模板

创建测试类

image.png

效果如下

image.png

接口和枚举同样有效果的,这里不展示了

函数注释模板

在对象函数上输入:/*+Tab(这里结合自己的快捷键名称和模板内容) image.png