如何在idea添加属于自己的注解模板

焕huang
581 阅读1分钟

## 1、打开idea的设置，找到Editor-->File and Code Templates--->Files，进入该页面后可选择Class、Interface、Enum等文件，对应右侧内容分别为：

1.png

2.png

代码如下

/**
 *@ClassName ${NAME}
 *@Description TODO
 *@Author huang
 *@Date ${DATE} ${TIME}
 *@Version 1.0\
 */

其中，代码表示的含义如下：

PACKAGENAME:包路径 {PACKAGE_NAME} : 包路径\ {NAME} : 文件名，该条语句可以获取到类名、接口名等
TODO：代办事项的标记，一般生成类或方法都需要添加描述
USER：主机用户名，设置创建类的用户 {USER} ： 主机用户名，设置创建类的用户\ {DATE} ： 系统当前日期，格式为：yyyy/mm/dd，设置创建日期
TIME：系统当前时间格式为：HH:mm，设置创建日期 {TIME} ： 系统当前时间 格式为：HH:mm，设置创建日期\ {YEAR}：当前年
MONTH：当前月 {MONTH}：当前月\ {MONTH_NAME_SHORT} ： 月份名称简写；如：Jan, Feb, etc.
MONTHNAMEFULL：月份名称全拼；如：January,February. {MONTH_NAME_FULL} ： 月份名称全拼；如：January, February.\ {DAY} ：当前天
DAYNAMESHORT：星期简写；如：Mon,Tue,etc. {DAY_NAME_SHORT} ：星期简写；如：Mon, Tue, etc.\ {DAY_NAME_FULL}：星期全写；如：Mon, Tue, etc.
HOUR：当前小时 {HOUR} ： 当前小时\ {MINUTE} ：当前分钟
${PROJECT_NAME} ： 项目名称` 这样第一步新建文件时的模板就设置好了

## 2、设置自己的实时模板注解

在设置中Editor-->Live Templates
点击右侧的“+”，选择“2.Template Group”，新建一个模板命名为methodTemplates，点击OK。

3.png

然后在建立好的methodTemplates模板上点击右侧的“+”，新建一个“1.Live Template”

4.png

在3处输入模板的简写码：*

在4处输入方法的描述：add Comments for method

在5处输入注释模板代码，可变变量要用$来表示（两侧括起来），如果不这样设置，6不能点击打开

/**
*@MethodName $title$
*@Description $description$ $param$ $return$ $throws$
*@Author huang
*@Date $date$ $TIME$\
*/

点击6对变量进行编辑，参数设置如下：

5.png

接下来设置该模板的作用范围，该位置首次设置是为Define，修改后设置时变为Change，可设置为Everywhere，表示任意位置都可以添加。

最后点击右下方Options中的Expand With可设置配合使用的快捷键，有Tab、Space、Enter等，如果上面设置的模板关键词为*，此处可默认使用Tab作为快捷键。

avatar
文章
阅读
粉丝