【IDEA】IDEA配置类、方法注释模板

IDEA配置类注释模板

打开 IDEA 的

Settings

，点击

Editor-->File and Code Templates

，点击右边

File

选项卡，在下面找到的

Class

，将注释模板配置到图中红框内后，点击Apply按钮，而后点击OK按钮，即可完成类注释配置

类注释示例模板如下：

/**
 * @ClassName：${NAME}
 * @Author: ${USER}
 * @Date: ${DATE} ${TIME}
 * @Description: 必须描述类做什么事情,实现什么功能
 */

本文提供的示例模板中，说明了类名称、作者、时间和类描述，IDEA 支持的所有的模板参数在下方的 **

Description

** 中被列出，如下图

保存后，当你创建一个新的类的时候就会自动添加类注释。如果你想对接口也生效，按照上述配置，配置Files选项卡中的**

Interface

** 项即可

IDEA配置方法注释模板

相较于类模板，为方法添加注释模板就较为复杂，

首先在

Settings

中点击

Editor-->Live Templates

。

点击上方的

+

，首先选择

2.Template Group...

来创建一个模板分组，如图

创建

Template

分组

在弹出的对话框中填写分组名，本文创建的示例分组名

为 **JavaMethod**

创建方法注释模板

然后选中刚刚创建的模板分组

**JavaMethod**

，然后点击

+

，选择

1.Live Template

：

配置方法注释模板

此时就会创建了一个空的模板，我们修改该模板的 **

Abbreviation、

Description

和

Template text

。需要注意的是，

Abbreviation

** 必须为 **

*

**，最后检查下 **

Expand with

**的值是否为 **Enter **键。

上图中

Template text

内容如下，请直接复制进去，**需要注意首行没有

/

，且

\*

是顶格的**。

 *
 * @Title: $titleName$
 * @Author: $user$
 * @Date: $date$ $time$
 * @Params: $param$ 
 * @Return: $return$
 * @Description: TODO 描述方法主要功能
 */

**注意:**右下角的

No applicable contexts显示为⚠️号

，这说明此时这个模板还没有指定应用的语言，点击

Define

，在弹框中勾选

Java

，表示将该模板应用于所有的 Java 类型文件。完成

applicable contexts

设置。如下图：

接下来我们配置

Template text

时里面包含了类似于

$date$

这样的参数，此时 IDEA 还不认识这些参数是啥玩意，下面我们对这些参数进行方法映射，让 IDEA 能够明白这些参数的含义。点击

Edit variables

按钮：

配置

Expression

每一个参数设置相对应的

Expression，如下图：

配置返回参数的Expression的脚本

groovyScript("
    def result='';  
    def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split('<').toList(); 
    for(i = 0; i < params.size(); i++) {
        if(i!=0){
            result+='<';
        };  
        def p1=params[i].split(',').toList(); 
        for(i2 = 0; i2 < p1.size(); i2++)  { 
            def p2=p1[i2].split('\\\\.').toList();  
            result+=p2[p2.size()-1];
            if(i2!=p1.size()-1){
                result+=','
            }  
        } ; 
    };  
    return result", methodReturnType()) 

验证&使用

输入 /** 回车 即可。
效果如下

package org.aurora;

/**
 * @ClassName：TestTemplate
 * @Author: mac
 * @Date: 16.7.24 19:03
 * @Description: 必须描述类做什么事情, 实现什么功能
 */
public class TestTemplate {

    /**
     * @Title: testMethodTemplate
     * @Author: mac
     * @Date: 2024-07-16 19:05:05
     * @Params: [test]
     * @Return: String
     * @Description: TODO 描述方法主要功能
     */
    public String testMethodTemplate(String test){
        return null;
    }
}

IDEA 设置导入导出

导出IDEA设置

打开 IDEA ，点击

File-->Manage IDE Settings-->Export Settings,打开导出功能，

如下图

检查导出的设置中包含

Live Templates，

选择导出路径，导出即可

导入IDEA设置

打开 IDEA ，点击

File-->Manage IDE Settings-->Import Settings,打开导入功能，

选择刚刚导出的settings.zip即可

如下图

至此完整的IDEA注释模板配置到此结束。

本文中设置的注释案例的settings.zip文件已上传至本平台，有需要的朋友可进行下载使用