IDEA 设置类注释模板作者、日期、描述等信息（推荐标准！）

IDEA 设置类注释模板作者、日期、描述等信息（推荐标准！）

引用

CSDN

1.

https://blog.csdn.net/MacWx/article/details/137670493

IntelliJ IDEA 注释模板配置指南

IntelliJ IDEA作为一款广受欢迎的开发工具，代码注释对于代码的可读性和维护性至关重要。本文将详细介绍如何在IDEA中配置类注释和方法注释模板，帮助开发者快速统一代码注释风格。

1. 新建类时自动添加类注释

要实现新建类时自动添加类注释，可以按照以下步骤进行配置：

1. 打开IDEA的设置窗口：

• 选择 File -> Settings
• 在搜索框中输入 Templates

2. 进入 File and Code Templates 配置页面

3. 在右侧选择 Files 选项卡，然后选择 Class

4. 在最右侧的输入栏中，输入以下注释代码模板：

   /**
   *@Author: 
   *@CreateTime: ${YEAR}-${MONTH}-${DAY}
   *@Description: ${description}
   *@Version: 1.0
   */
   

   请将 @Author 处的占位符替换为你的信息。

5. 点击保存即可完成配置。

可选配置： 如果需要设置接口和枚举的注释模板，可以在第3步中选择 Interface 或 Enum，然后按照相同步骤进行配置。

配置完成后，每次创建类文件时会弹出两次窗口，一次用于输入文件名，一次用于输入类描述。

2. 自定义方法注释模板

IDEA支持自定义方法注释模板，但需要一些额外的配置才能实现。以下是具体步骤：

1. 打开IDEA的设置窗口：

• 选择 File -> Settings
• 进入 Editor -> Live Templates

2. 点击右上角的 + 号，创建一个新的模板组，例如命名为 MyGroup

3. 在新创建的模板组中再次点击 + 号，创建一个新的Live Template

4. 配置模板内容：

• Abbreviation：模板的缩写，可以是 /、/** 等，建议使用 /**
• Description：模板的描述，例如 "方法注释"
• Template text：模板的具体内容，参数名用 $参数名$ 格式
• Expand with：模板的扩展快捷键，可以选择 Tab 或 Enter

5. 配置模板格式：

   /*
   * @Description: $description$ $params$
   * @return: $returns$
   * @Author:  $USER$
   * @date:  $date$ $time$
   */
   

6. 设置变量参数：

• 点击 Edit variables，在列表中显示的模板参数（如 $params$）需要特别处理
• 对于 $params$ 参数，需要使用自定义脚本来实现按行显示参数的效果
• 将以下脚本复制到 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++) {result+='\\n' + ' * @param ' + params[i] + ' '}; return result;}", methodParameters());
  

7. 设置应用场景：

• 选择需要应用该模板的编程语言，例如 Java

8. 测试效果：

• 创建一个方法
• 在方法上方输入 /**，然后按下 Enter 键
• 应该会自动生成相应的注释

解决 "Wrong tag 'Description'" 报错

如果在生成注释后遇到 "Wrong tag 'Description'" 的报错，可以通过以下步骤解决：

1. 打开IDEA的设置窗口：

• 选择 File -> Settings
• 进入 Editor -> Inspections

2. 在搜索框中输入 Wrong tag

3. 找到 Javadoc 相关的检查项，点击旁边的 ... 按钮

4. 在弹出的对话框中，将自定义的标签添加到 Allowed tags 列表中，例如：

   Description:,Version:,CreateTime:,Auther:,param,param:,description:,date:,
   

5. 点击 Apply 和 OK 完成配置。

通过以上步骤，你就可以在IntelliJ IDEA中实现统一的类注释和方法注释模板，提高代码质量和团队协作效率。