【IDEA】设置自定义类注释，自定义方法注释

IDEA自定注释

---

前言

由于在写代码过程中，自带的注释缺少部分信息，如author，time等信息，需要新增这些注释信息，根据网上其他资料总结，分为类注释和方法注释，下面开始介绍如何设置。

---

一、类注释

1、打开设置

• 打开设置：Settings->Editor->File and Code Templates，如下图。

2、修改模板引用

• 类模板引用
  根据文件类型修改class或interface或enum等。

#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end
#parse("File Header.java")
public class ${NAME} {
}

3、修改头文件模板

• 类头文件注释模板（File Header.java）

/**
 * @title ${NAME}
 * @date ${DATE} ${TIME}
 * @author ${USER}
 * @description TODO
 */

二、方法注释

1、打开设置

• 打开设置：Settings->Editor->File and Code Templates，如下图。

2、创建模板组Template Group

• 创建一个模板组，自定义名称，这里取名为：Annotation
  
• 选择创建好的模板组，在模板组中创建一个模板
  

3、完成配置

• 添加触发关键字，这里设置为：**
  

• 选择适用的文件类，勾选上Java
  

• 设置模板格式，变量，触发按键
  

• 模板格式

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

• 变量设置
  
• 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) ? '\\r\\n' : '')}; return result", methodParameters())

• return设置

groovyScript("def result=\"${_1}\"; if(result == \"void\"){return \"\";}else{return \"{@link \"+result+\"}\";}", methodReturnType()) 

• 完整配置
  

---

三、结果展示

1、类注释（创建时触发）

2、自定义方法注释（之前设置为：Tab触发）

• 输入：/**
• 按Tab触发方法注释
  
  

如有问题，请指出一起讨论