IDEA高清图解设置注释模板（超详细）

左手的ㄟ右手 2023-02-14 10:54 21阅读 0赞

# IDEA 图解注释模板设置 #

1.  打开IDEA - > Setting - > Editor - > Live Templates 。打开后，显示如下界面。

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDE3MDIyMQ_size_16_color_FFFFFF_t_70]

1.  \+ - > Tempalte Group…。打开后显示如下页面。

> 创建注释模板的分组

![\[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-t5FuabdA-1591092254496)(https://gitee.com/Ziphtracks/Figurebed/raw/master/img/20200602173336.png)\]][img-t5FuabdA-1591092254496_https_gitee.com_Ziphtracks_Figurebed_raw_master_img_20200602173336.png]

![\[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-nWjukVg7-1591092254500)(https://gitee.com/Ziphtracks/Figurebed/raw/master/img/20200602173436.png)\]][img-nWjukVg7-1591092254500_https_gitee.com_Ziphtracks_Figurebed_raw_master_img_20200602173436.png]

![image-20200602173502461][]

1.  \+ - > Live Tempalte 。打开后显示如下页面。

> 注意：
> 
>  *  一定要先创建我们注释模板的分组，在去创建注释模板。
>  *  因为我们的文档注释的使用快捷键即是`/** + Enter`，所以我们在设置使用注释模板快捷键的时候设置为类注释模板的两个小写首字母，也就是cc，为了好记嘛，而且还短方便键入。
>  *  注释模板不唯一，大家自行修改！但是现在已经很全了！

![image-20200602175003860][]

![image-20200602173825117][]

> 注释模板参数解释：
> 
>  *  ClassName：类名
>  *  Description：描述（自行添加修改类的描述）
>  *  Author：作者
>  *  Date：创建时间
>  *  Since：jdk版本
>  *  Version：产品的版本号

*
     * @ClassName $name$
     * @Description TODO
     * @Author $user$
     * @Date $date$
     * @Since 1.8
     * @Version 1.0
     */

1.  Edit variables

> 注意：
> 
>  *  要把注释模板的快捷键键入形式改为Enter，就可以使用Enter键入了！
>  *  Expression代指参数表示什么，我们设置对应的参数表示注释信息即可。

![image-20200602174005218][]

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDE3MDIyMQ_size_16_color_FFFFFF_t_70 1]

![image-20200602174200925][]

1.  Define - > Java

> 选择自己注释模板的应用语言场景
> 
> 注意：
> 
>  *  点击Define选择语言场景
>  *  这里我们是设置的类的注释模板、语言是Java，所以我们全选Java

![image-20200602175224935][]

![image-20200602175257459][]

1.  使用注释模板

> 在类的上方键入`/*cc + Enter`，后显示注释模板，如下：

![image-20200602174344888][]

#  #

--------------------

# 修改 IDEA 注释模板中的 user 内容（作者信息） #

> 首先，大家要知道。我们的`${USER}`表示主机名。也就是说我们电脑的主机名是什么IDEA会解析什么内容，并添加注释中。而且我们写死作者的话，感觉不太好。所以大家可以修改IDEA的配置文件来解决此问题。

1.  Help - > Edit Custom VM Options…

![image-20200602180209540][]

1.  在配置文件中添加 `-Duser.name=作者名称`，重新IDEA便会生效

> 注意：一定要记得重启IDEA才会生效哦！

-Duser.name=Ziph

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDE3MDIyMQ_size_16_color_FFFFFF_t_70 2]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDE3MDIyMQ_size_16_color_FFFFFF_t_70]: https://img-blog.csdnimg.cn/2020060218065894.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDE3MDIyMQ==,size_16,color_FFFFFF,t_70
[img-t5FuabdA-1591092254496_https_gitee.com_Ziphtracks_Figurebed_raw_master_img_20200602173336.png]: https://img-blog.csdnimg.cn/20200602180714709.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDE3MDIyMQ==,size_16,color_FFFFFF,t_70
[img-nWjukVg7-1591092254500_https_gitee.com_Ziphtracks_Figurebed_raw_master_img_20200602173436.png]: https://img-blog.csdnimg.cn/20200602180733831.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDE3MDIyMQ==,size_16,color_FFFFFF,t_70
[image-20200602173502461]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9naXRlZS5jb20vWmlwaHRyYWNrcy9GaWd1cmViZWQvcmF3L21hc3Rlci9pbWcvMjAyMDA2MDIxNzM1MDQucG5n?x-oss-process=image/format,png
[image-20200602175003860]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9naXRlZS5jb20vWmlwaHRyYWNrcy9GaWd1cmViZWQvcmF3L21hc3Rlci9pbWcvMjAyMDA2MDIxNzUwMDUucG5n?x-oss-process=image/format,png
[image-20200602173825117]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9naXRlZS5jb20vWmlwaHRyYWNrcy9GaWd1cmViZWQvcmF3L21hc3Rlci9pbWcvMjAyMDA2MDIxNzM4MjYucG5n?x-oss-process=image/format,png
[image-20200602174005218]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9naXRlZS5jb20vWmlwaHRyYWNrcy9GaWd1cmViZWQvcmF3L21hc3Rlci9pbWcvMjAyMDA2MDIxNzQwMDcucG5n?x-oss-process=image/format,png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDE3MDIyMQ_size_16_color_FFFFFF_t_70 1]: https://img-blog.csdnimg.cn/20200602180633843.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDE3MDIyMQ==,size_16,color_FFFFFF,t_70
[image-20200602174200925]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9naXRlZS5jb20vWmlwaHRyYWNrcy9GaWd1cmViZWQvcmF3L21hc3Rlci9pbWcvMjAyMDA2MDIxNzQyMDMucG5n?x-oss-process=image/format,png
[image-20200602175224935]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9naXRlZS5jb20vWmlwaHRyYWNrcy9GaWd1cmViZWQvcmF3L21hc3Rlci9pbWcvMjAyMDA2MDIxNzUyMjYucG5n?x-oss-process=image/format,png
[image-20200602175257459]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9naXRlZS5jb20vWmlwaHRyYWNrcy9GaWd1cmViZWQvcmF3L21hc3Rlci9pbWcvMjAyMDA2MDIxNzUyNTkucG5n?x-oss-process=image/format,png
[image-20200602174344888]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9naXRlZS5jb20vWmlwaHRyYWNrcy9GaWd1cmViZWQvcmF3L21hc3Rlci9pbWcvMjAyMDA2MDIxNzQzNDYucG5n?x-oss-process=image/format,png
[image-20200602180209540]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9naXRlZS5jb20vWmlwaHRyYWNrcy9GaWd1cmViZWQvcmF3L21hc3Rlci9pbWcvMjAyMDA2MDIxODAyMTEucG5n?x-oss-process=image/format,png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDE3MDIyMQ_size_16_color_FFFFFF_t_70 2]: https://img-blog.csdnimg.cn/20200602180550224.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDE3MDIyMQ==,size_16,color_FFFFFF,t_70