Java-IDEA创建文件时自动附带注释的两种方法-详细配置步骤

萌新在参考学习网上代码示例时经常能遇见诸如下列格式的开头注释，下面展示两种配置方法。

/**
 * @ClassName : basedVariable  //类名
 * @Description : based variable  //描述
 * @Author : 15829 //作者
 * @Date: 2025/2/6  18:50
 */

第一种方法：

在IDEA中找到“文件”-“设置”-“编辑器”-“文件和代码模板”，找到文件下的“Class”文件

可以看到红色下划线的代码中提到了一个名为“File Header.java"的文件

我们去“文件”右侧的“包含”页中可以找到这个文件，这个文件一开始是没有内容的，我们加入如下内容：

/**
 * Description:TODO 
 * Author:${USER}
 * Date:${YEAR}-${MONTH}-${DAY}
 *
 */

记得点击右下角的“应用”进行保存      

 这时再创建一个新的类文件时就会自动带上自定义的注释

第二种方法：

在IDEA中找到“文件”-“设置”-“编辑器”-“文件和代码模板”，找到文件下的“Class”文件

 此时我们直接在Class模板中配置注释即可，内容参照如下：

/**
 * @ClassName : ${NAME}  //类名
 * @Description : ${description}  //描述
 * @Author : ${USER} //作者
 * @Date: ${DATE}  ${TIME}
 */

点击“应用”进行保存后，我们此时创建一个新的Java类时会弹出一个额外的输入项：description

输入内容（不输入也行）后注释效果如下：

总结

第一种方法是多类型文件创建时引用一种注释格式

第二种方法是单类型文件创建时使用固定注释格式