idea配置注释模板

水深无声 2022-01-16 08:05 478阅读 0赞

废话不多说直接进入正题

一、想要创建class文件时就带有注释，则按一下配置

1）、打开配置界面File->Settings

2）、搜索File and Code Templates

3）、在右侧Class中添加注释模板(模板内容根据自己情况配置)

/**
    * @Description:    类描述
    * @Author:         zhao
    * @CreateDate:     $DATE$ $TIME$
    * @UpdateUser:     zhao
    * @UpdateDate:     $DATE$ $TIME$
    * @UpdateRemark:   修改内容
    * @Version:        1.0
    */

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MTk5NjYzMg_size_16_color_FFFFFF_t_70][]

二、类已创建，想要手动自动导入模板，则按以下配置

1）同样打开Settings

2）搜索Live Templates

3、点击右侧+，选择Templates group

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MTk5NjYzMg_size_16_color_FFFFFF_t_70 1][]

4)选中zz继续点击右侧+，选择Live Template,结果如下

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MTk5NjYzMg_size_16_color_FFFFFF_t_70 2][]

5）对内容进行配置如下，模板内容还是上面一样的模板，根据情况自行修改

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MTk5NjYzMg_size_16_color_FFFFFF_t_70 3][]

6）、选择文件,本人截图后因弹框消失，网上找的图片代替，点击上图中下面的Define(在上图中最下面的警告后面),出现下图，选中java和javaScript

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MTk5NjYzMg_size_16_color_FFFFFF_t_70 4][]

7）配置日期和时间

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MTk5NjYzMg_size_16_color_FFFFFF_t_70 5][]

8）点击确定

9）验证如下，出现提示，点击提示即可导入模板

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MTk5NjYzMg_size_16_color_FFFFFF_t_70 6][]

三、方法注释模板

此方法与上面手动添加过程一样，不同的是配置，这里贴上配置，这里的配置有个问题，就是不智能，没有返回值，没有参数，没有异常时仍然又相关的注释，见下面验证图中的的注释

/**
    * @Description:    方法实现说明
    * @author      zhao
    * @param       $param$
    * @return      $return$
    * @exception   $exception$
    * @date        $date$ $time$
    */

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MTk5NjYzMg_size_16_color_FFFFFF_t_70 7][]

验证：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MTk5NjYzMg_size_16_color_FFFFFF_t_70 8][]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MTk5NjYzMg_size_16_color_FFFFFF_t_70]: /images/20220114/4fedbd54ea1e43f5ba44de623b3f23a8.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MTk5NjYzMg_size_16_color_FFFFFF_t_70 1]: /images/20220114/09743ec1edf34848abb2e0eb9facbd9b.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MTk5NjYzMg_size_16_color_FFFFFF_t_70 2]: /images/20220114/5b5bbd9d069d441cb7b387e58612221a.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MTk5NjYzMg_size_16_color_FFFFFF_t_70 3]: /images/20220114/82b2453c09de4abd8d78ab2f0caeca60.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MTk5NjYzMg_size_16_color_FFFFFF_t_70 4]: /images/20220114/f70926d398e84c28b85ba08af4899d89.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MTk5NjYzMg_size_16_color_FFFFFF_t_70 5]: /images/20220114/8bd29b31cc07435eb04c6f85d26f6bf9.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MTk5NjYzMg_size_16_color_FFFFFF_t_70 6]: /images/20220114/58e12518655546fa9db7bc77219db0e4.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MTk5NjYzMg_size_16_color_FFFFFF_t_70 7]: /images/20220114/2ca0a96c7acf4be997de511d5d1097d3.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MTk5NjYzMg_size_16_color_FFFFFF_t_70 8]: /images/20220114/2bbcf874c2f64be38bba1674fee33d18.png