IntelliJ IDEA 通过文件代码模板自定义类注释

---

前言

《阿里巴巴Java开发手册》中注释规约就强制要求所有的类都必须添加创建者和创建日期。我们在日常开发中添加类注释也是非常好的编程习惯。本文就来介绍在 IDEA 中如何在新建类时自动添加类注释。

---

一、实现目标

IDEA 通过文件代码模板自定义类注释，在新建 Java 文件自动生成类注释，实现如下效果：

二、操作环境

• 操作系统：Windows 10
• IDE 工具：IntelliJ IDEA 2021.1.1

三、文件模板介绍

文件模板介绍直接引用官方：

文件模板是创建的新文件的默认内容的规范。根据正在创建的文件类型，模板提供了该类型的所有文件(根据行业或语言标准、公司政策或其他原因)中所期望的初始代码和格式。例如，这可以是样板代码、关于作者信息等等。

IntelliJ IDEA 为创建新文件时建议的所有支持的文件类型提供了预定义模板。建议的文件类型集取决于模块和配置，以及项目工具窗口中当前位置的属性。例如，IntelliJ IDEA 不会建议在Java源或测试目录之外创建 Java 类文件。

四、具体实现

1.进入文件代码模板管理配置界面

Ctrl+Alt+S/Settings --> Editor --> File and Code Templates

2.文件代码模板管理界面介绍

(1) Scheme

Scheme 设置有两个选项：Default 和 Project

• Default 范围控制应用于任何项目中整个工作区的模板。它们存储在 fileTemplates 下的 IDE 配置目录中。
• Project 范围控制只应用于当前项目的模板。它们存储在 .idea/fileTemplates 下的 project 文件夹中。这些模板可以在团队成员之间共享。

(2) 模板类型

IntelliJ IDEA 使用了几种类型的模板，分为以下选项卡:

• Files 选项卡包含用于创建新文件的文件模板。
• Includes 选项卡包含可插入到文件模板中的可重用内容(例如，一个特定的头应用于多个文件模板)。
• Code 选项卡包含 IntelliJ IDEA 用来生成各种构造的代码片段(片段)的内部模板。您可以编辑此选项卡上可用的代码段，但不能创建新的代码段。要创建自定义代码片段，请使用 Live Templates。
• Other 选项卡包含各种应用服务器和框架使用的模板。您可以在此选项卡上编辑现有的内置模板，但不能创建新的模板。

(3) 界面内容

在每个选项卡下都有一下模块：模板列表、模板预览、描述。

• 模板列表：可以对模板进行新增、删除、复制等操作。
• 模板编辑：对选中模板内容进行编辑，通过勾选可以实现：
  • 根据风格重新格式化
  • 启用 Live Templates
• 描述：是对配置用法进行说明。

3.自定义类注释模板

(1) Class模板

Files 选项卡下载模板列表中选择 Class 。

在编辑区域看到的模板代码，在结合描述区域其实很好理解：

• 第一行代码：是用 #if 判断包名是否为空，不为空就将包名填写到此位置。
• 第二行代码：使用 #parse插入了另一个名为 File Header.java 的模板的内容。
• 第三行代码：是将文件名传递到此位置。

(2) File Header.java

配置的重点就在 File Header.java 文件。通过文件名或是该文件代码所在位置也可以知道这里可以配置类注释。

参考描述中的预定义变量，可以简单配置类注释。

/**
 * ${NAME}
 *
 * @author Ongoing蜗牛
 * @since ${DATE} ${TIME}
 */

直接将代码复制到编辑区域，点进【Apply】和【OK】。新建Java类进行验证，这里新建 ClassAnnotation.java，效果如下：

---

总结

这里学习并记录…
参考官方网站文档…
应该为类添加类注释，好处多多…
阿里巴巴Java开发手册中注释规约就强制要求所有的类都必须添加创建者和创建日期…
配置模板在创建Java类后自动生成类注释，不必每次手写或复制…