Intellij IDEA 注释模板设置

1. idea 类注释

  打开 idea：file->setting->Editor->Filr and Code Templates->Includes->File Header

  类注释模板：

/**  
  * @className: ${NAME}
  * @description: ${TODO}
  * @author ${USER}
  * @date ${DATE} ${TIME}
  * @version：1.0
  */

2. 方法注释模板

  打开 idea：file->setting->Editor->Live Templates 点击右边上面那个的 + 号，选择 Template Group，然后弹出一个窗口，随便添加一个名字，我这里添加的是 MyJavaGroup。选中 MyJavaGroup 点击右边 + 号，选择 Live Template，如下所示：

  接下来按如下图配置：

  方法注释模板：

**
 * @Description: TODO
 $param$
 * @return $return$
 * @author $user$
 * @date $date$ $time$
 */

  配置模板为 java 所用：

  配置变量表达式：

  param 的 Default value 内容如下：

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

  修改 Enter 触发

  测试效果：在方法上 /* + Enter 触发

/**
 * @Description: TODO
 * @param a: 
 * @param b: 
 * @return java.lang.String
 * @author Administrator
 * @date 2021/6/26 22:53
 */  
public String method(String a, Integer b) {

     return "0";
}

3. 字段注释模板

  跟方法注释模板一样的设置方式

  字段注释模板：

/**
 * $TODO$
 */