IDEA自定义类和方法的注释

以你之姓@ 2022-03-29 14:07 331阅读 0赞

### 文章目录 ###

*  自定义类注释
 *  自定义方法注释
 *   *  添加Template Group
     *  添加Live Template
     *  其它
 *  使用自定义注释

# 自定义类注释 #

依次打开下面的面板`File`\->`Settings`\->`Editor`\->`File and Code Templates`，其显示的界面如下所示：

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

在上面的`Files`面板区域中选择`Class`，在右侧的面板中编辑如下：

/**
      * @author: ${USER}
      * @date: ${DATE} ${TIME}
      * @description: //TODO 请完善注释信息
      **/

其中`${USER}`指定的是系统用户名，`${DATE}`指定的是当前的日期，`${TIME}`指定的是当前的时间。

# 自定义方法注释 #

## 添加Template Group ##

依次打开`File`\->`Settings`\->`Editor`\->`Live Templates`面板，点击下图中的`+`然后选择`Template Group`。

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

在弹出的面板中我们可以自定义自己的模版分组名称，此处我的自定义模版分组名如下：

![在这里插入图片描述][20190108212247172.png]

## 添加Live Template ##

点击图示中的`+`，在弹出的对话框中选择`Live Template`，如下所示：

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

此处我们的自定义模版缩写为`/*`，如下所示：

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

在上图中的`Template text`中，我自定义的方法注释模版如下：

/**
      * @description: //TODO 请完善注释信息
      * @author: $author$
      * @date: $date$ $time$ 
      * @param: $param$
      * @return: $return$
      **/

点击图示的`Define`。

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

在弹出的面板中选择`Java`，也就是说我们其实是想要添加的是Java类型的注释。

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

点击`Edit variables`按钮，在弹出的面板中进行如下编辑：

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

## 其它 ##

在`Template Group`中我们还可以添加其它的自定义注释，比如说`xml`、`html`、`jsp`等等，添加完成后的结果如下：

![在这里插入图片描述][20190109112839200.png]

由于后续几种注释的添加方式与上面大同小异，因而我就不在这里一一说明了。

# 使用自定义注释 #

在使用自定义方法注释时，直接在方法名称上输入`/*`，然后点击`tab`按键，即可生成自己的自定义注释。

比如说我生成的注释如下：

/** * @author: HP * @date: 2019/1/8 21:49 * @description: //TODO 请完善注释信息 **/
    public class DemoTest { 
        
        /** * @description: //TODO 请完善注释信息 * @author: HP * @date: 2019/1/8 21:49 * @param: * @return: **/
        public void testDemo(){ 
            
        }
    }

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L1paWTEwNzg2ODkyNzY_size_16_color_FFFFFF_t_70]: /images/20220329/abde9638682f42568ef67446a4fede83.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L1paWTEwNzg2ODkyNzY_size_16_color_FFFFFF_t_70 1]: /images/20220329/b78b7c46c0e6444d8aa165b045a3f5d4.png
[20190108212247172.png]: /images/20220329/6feebb313936451da6ede6a988f2cb73.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L1paWTEwNzg2ODkyNzY_size_16_color_FFFFFF_t_70 2]: /images/20220329/a5667cc1d59f45de888fb3c29d1e4fba.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L1paWTEwNzg2ODkyNzY_size_16_color_FFFFFF_t_70 3]: /images/20220329/e766b37d1c314f67a48508680ca27309.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L1paWTEwNzg2ODkyNzY_size_16_color_FFFFFF_t_70 4]: /images/20220329/b961048541af411e84a6e5afa7d9a738.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L1paWTEwNzg2ODkyNzY_size_16_color_FFFFFF_t_70 5]: /images/20220329/57c5651226fb462cb72a703ca7e416eb.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L1paWTEwNzg2ODkyNzY_size_16_color_FFFFFF_t_70 6]: /images/20220329/e144f2eeb3f1486f807cbd2cac494293.png
[20190109112839200.png]: /images/20220329/8c2ef582d8294be79c541fff01a63831.png