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

前言

开发中类和方法的注释是不可避免的，都会有大量的注释，IDEA自带的注释不够详细，每次需要添加修改，可自定义类和方法的注释模板，提升开发效率

类模板注释设置

Windows：File–>settings–>Editor–>File and Code Templates–>Files
Mac：Preferences -->Editor–>File and Code Templates–>Files

/**
 * @description: TODO 
 * @author ${USER}
 * @date ${DATE} ${TIME}
 * @version 1.0
 */

选择Class , Interface ，Enum 等等，我们都可以看到，在右侧区域中，在public class 上面，都有一行 #parse(“File Header.java”)
类注释模板
这句话是引入了File Header.java文件，作为我们创建的Class Interface ,Enum 等文件的注释，我们选择Files右侧的Includes选项，在这里可以定义各种模板，在需要的地方去引入模板，前面类文件中已经引入了Header.java我们修改这个模板就行了
设置类模板注释

方法模板注释设置

Windows：File–>settings–>Editor–>Live Templates
Mac：Preferences -->Editor–>Live Templates

1、新建组并重命名
在Live Templates 右侧点击+号，添加一个Templates Group，命名为 methodTemplates
添加一个methodTemplates组
2、新建模板重命名
在刚刚创建的 methodTemplates 下创建一个 Live Templates 命名为*
因为IDEA生成注释的默认方式是：/*+模板名+快捷键（比如若设置模板名为add快捷键用enter，则生成方式为/*add+enter），如果不采用这样的生成方式IDEA中没有内容的方法将不可用，例如获取方法参数的methodParameters(）、获取方法返回值的methodReturnType(）
在这里插入图片描述
3、设置模板内容（如下）
注意第一行，只有一个*而不是/*
在设置参数名时必须用 ${参数名}$ 的方式，否则第五步中读取不到你设置的参数名

*
 * @Author $user$
 * @Description //TODO $end$
 * @Date $time$ $date$
 * @Param $param$
 * @return $return$
 **/

4、设置模板应用场景
点击模板页面最下方的警告，来设置将模板应用于那些场景，一般选择EveryWhere–>Java即可

Ps：如果曾经修改过，则显示为change而不是define
在这里插入图片描述
5、设置参数的获取方式，选择右侧的Edit variables按钮
6、效果图
创建方法，在方法上面写：/*+模板名+Enter–>/**+Enter

参考

IDEA类和方法注释模板设置（非常详细）