IDEA 设置注释模板

在进行开发的时候，尤其是在公司进行代码开发的时候，在你的代码上一般都要加上注释，常见的就是你的名称、创建日期、类的描述等，name如何去定义自己的注释模板呢？

设置类的模板

IDEA 中可以进行自己模板的定义。按照File–> Settings --> Editer–>>File and Code Templates–>Files中打开设置页面：

这里我们主要关注 Class、Interface、Enum 者几个模板的设置，因为我们平时主要用到着三个。选中Class 可以看到右面的默认的模板，我们可以这样去替换他：

/**
 * @Auther: ${USER}
 * @Date: ${DATE} ${HOUR}:${MINUTE}
 * @Description: ${NAME}
 * @Version 1.0.0
 */

其他的两个设置相同，然后点击OK就可以。

测试一下

发现是可以的。

设置方法的注释

IDEA没有可以直接设置方法注释模板的地方，可以借用Live Templates基本实现，步骤如下。

首先创建模板组

选择File–>Settings–>Editor–>Live Templates，先选择右侧绿色加号新建一个自己的模板组，如图，命名为methodTemplate

选中已建好的组，选择右侧绿色加号新建模板，如下图。

填写的模板为
注意这里的是*而不是 /*开头，因为这样才能比较好的使用我们定义的去实现模板，不然的话，最后的模板会有问题，很丑。

*
 *
 * @description: 
 * @param: $param$
 * @return: $return$
 * @date: $date$ 
 */

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-hHbpdvX8-1596284618187)(https://upload-images.jianshu.io/upload_images/20337942-1c7dda1f0e01e9dc.png?imageMogr2/auto-orient/strip%7CimageView2/2/w/1240)]

点击那个Define，然后勾选使用的场景，这里我们勾选Java就行了。

然后点击Edit variables 进行如下的设置：

最后点击OK 就行了。

补充说明

这里的Expand with 是你输入快捷键后的按键，也就是你输入/**之后，你要按Tab键才能使用上面设置的模板，当然这个键可以你自己去设置。

测试验证

成功！！！

结语

如果本文章对你有所帮助的话，请帮忙点个赞！！！