IDEA 中自定义设置类注释和方法注释(详解)

在网上看了很多都太乱，而且说的不清楚，操作后没有效果，这里我整理一个详细的傻瓜式的操作

一、IDEA中设置注释模板主要分为两个部分，分别是类的注释和方法的注释。

1、选择File→Settings→Editor→File and Code Templates→Files→Class。可以看到创建Class时引入了一个参数"File Header.java"。对应的是Files旁边的Includes→File Header文件。

1、选择File→Settings→Editor→File and Code Templates→Files→点击+号，会创建一个文件，自定义命名，这里我命名为class了

创建好Class文件后，

方法一、注释和类一体设置 ，（简单方便）将下面代码复制到class右边的输入框里面点击 OK

#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end /** * @program: ${PROJECT_NAME} * @author: xlk * @create: ${YEAR}-${MONTH}-${DAY} ${HOUR}:${MINUTE} */ #parse("File Header.java") public class ${NAME} { }

方法二、注释和类分开设置 ，（麻烦，繁琐）

1）、将下面代码复制到class右边的输入框里面

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

2）、然后点击Files旁边的Includes→File Header文件。将下面的代码复制到右边输入框中

/** * @program: ${PROJECT_NAME} * @author: 这里是你要写开发者姓名 * @create: ${YEAR}-${MONTH}-${DAY} ${HOUR}:${MINUTE} **/

右下角官方给提供了一些注释模板，如需要可以自定义，然后点击  OK 或者 Apply 按钮

通过idea创建类的时候就会自动添加注释了，如图所示

下面讲解方法的自定义注释模板

1、同样选择File→Settings→Editor→Live Templates。点击右边的加号，选择第二个 Template Group，创建一个分组。

1、弹出创建组的框，这里我定义一个名称，点击 OK

2、先选中刚创建的组名，再点击右边 + 号，选择第一个 Live Template，创建一个模板。

3、其中：<abbreviation>：填模板的缩写，（也可以认为是设置的快捷键）可以使用**号作为代号，方便后面调用模板。

4、Options→Expand with：填注释模板的扩展快捷键，这里使用默认的Enter。

5、Template text：填写注释模板的内容。参数名使用${参数名}$的格式。（注意：注释模板开头的/不要填写，否则会出现param为null的情况）

注释模板的内容如下：（注意模块也可以直接复制到Template text的输入框内）

**  * @Description: $description$  * @Param: $params$  * @return: $return$  * @Author: xlk  * @Date: $time$ $date$  */

如下图所示

6、然后点击上图 5所示的 Edit variables，会读取刚刚在注释模板中的配置的参数${参数名}$。在Expression的下拉框中选择方法为其赋值。如图所示：需要哪个注释模板就在后面打钩，每个参数官方都给提供参数了，点击箭头所指的下落款可以选择；

其中 params 可以用默认的，也可以自定义；

默认如下图所有参数在一行展示：

自定义 params ，将下面的代码复制到 Expression 下的 params里面

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())

注释模板如图所示

7、点击模板页面最下方的警告define，来设置将模板应用于哪些场景，我这里选择Java及其子元素

8、选中后如下图所示，会出现一排英文，点击OK保存即可