IDEA设置新建类注释、手动注释详解

比眉伴天荒 2024-02-05 21:44 124阅读 0赞

#### 文章目录 ####

*  一、背景
 *  二、模板
 *  三、设置方法
 *   *  1、新建类注释设置
     *  2、手动注释设置

## 一、背景 ##

> 每次在一台新电脑安装idea，都需要重新设置idea注释配置，说常用吧，也就新安装时才用，时间久步骤容易忘记，所以用此文章记录一下。

## 二、模板 ##

> 此文章我们就用以下模板来进行讲解

/**
     * @author henry
     * @describe  todo
     * @data $date$ $time$
     * @version 1.0
     */

## 三、设置方法 ##

### 1、新建类注释设置 ###

> 此步骤讲解的是新建类的时候，类自动能带出配置好的模板注释

> **步骤：**  
> 1、settings =》 Editor =》File and Code Templates  
> 2、点击includes后在File Header后面的栏框中输入模板内容即可  
> ![请添加图片描述][f0d75de1f45c48a981876436e0b3fd87.png]

> **新建类进行测试**  
> ![在这里插入图片描述][fbd1434c317f4fa9b69894e3d6467216.png]

### 2、手动注释设置 ###

> 此步骤讲解的是在方法上输入`“/*”然后回车`，即可自动展示注释模板

> 步骤：  
> 1、settings =》 Editor =》Live Templates  
> 2、在此目录下新建一个组模版（例如：myGroup）  
> ![在这里插入图片描述][638dfbbf39d24c979b614230bc296db8.png]  
> 3、进行如下设置（在上述myGroup下面新建一个Live Template）  
> ![在这里插入图片描述][87dfa5c5ebcb4fd7a93543e652b22cab.png]  
> **含义：**  
> 1和6结合表示输入/\*然后回车就可以自动补全注释模板；2表示对模板做解释；3表示模板；4对模板中的占位符变量进行赋值；5表示模板使用哪些文件，比如java（必须要设置）
> 
> **ps：对变量的设置**  
> ![在这里插入图片描述][cd6bf0bffda542838ee4d0c0eadfb727.png]

> **对设置好的配置进行测试（输入/\*，后回车）**  
> ![在这里插入图片描述][97c0ffe36ddc49da91360b59b2b35dc8.png]

[f0d75de1f45c48a981876436e0b3fd87.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/30/f692ea394bd74eb69b4c64a071183da7.png
[fbd1434c317f4fa9b69894e3d6467216.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/30/74ee9a3ca8384fb48cc1736bd60c59c9.png
[638dfbbf39d24c979b614230bc296db8.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/30/39d6dee196ac4d5b94ea7066d9808d84.png
[87dfa5c5ebcb4fd7a93543e652b22cab.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/30/4044828bb8314f32838d68cd73459a4c.png
[cd6bf0bffda542838ee4d0c0eadfb727.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/30/8ec1e744a0ad4a269fd394578aabe4aa.png
[97c0ffe36ddc49da91360b59b2b35dc8.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/30/1ff13b8300474deeadfa526249eed307.png