IDEA设置JAVA类和方法自定义注释模板方法

目录

一、类注释

二、方法注释

1 创建分组 Template Group

2 在分组里创建一个 Live Template 模版

3 配置 Live Template 模版

3.1 配置Abbreviation Description

3.2 配置Template text

3.3 配置Edit variables

3.4 配置 Options

3.5 配置模版应用范围

---

一、类注释

在IDEA中打开File-Settings，在Settings中打开Editor-File and Code Templates，在左边的Files中选中Class。

如上图，Class编辑框中，编写如下代码：

/**
 * @description: 
 * @author: liuyandeng
 * @date: ${DATE}
 */

上述代码在创建类时生成效果如下：

/**
 * @description: 
 * @author: liuyandeng
 * @date: 2024/12/30
 */

其他参数

${NAME}：设置类名
${USER}、${DATE}、${TIME}：设置创建类的用户、创建的日期和时间，还有一些其他的方法，比如：
项目名：${PROJECT_NAME}，
日期格式:${YEAR}年${MONTH}月${DAY}日 ${HOUR}:${MINUTE}:${SECOND}

二、方法注释

在Settings中打开Editor-Live Templates，如下图：

1 创建分组 Template Group

点击 " + " 号，选择Template Group，接着在弹出框中设置好这个组的名字，点击确定，例如：userDefine。

2 在分组里创建一个 Live Template 模版

选中上面我们刚刚创建的分组userDefine，然后点击 " + " 号，选择Live Template。

3 配置 Live Template 模版

3.1 配置Abbreviation Description

上图中Abbreviation设置项 ，是在我们要生成注释时，选择自己的某一个Live Template模版的快捷提示。IDEA生成注释的方式是：模板名+快捷键（比如设置模板名为a,快捷键用Tab，则生成方式为a+Enter），可以根据这个来选择使用不同的模版注释。不要把Abbreviation设置成斜杠，因为这会导致注释无法获取方法参数。设置成其他的字母或是符号都可以&