IDEA自动设置作者信息

╰半夏微凉° 2022-12-09 14:57 311阅读 0赞

#### 一、背景和痛点 ####

以前用Eclipse，忘记设置类的作者信息，是可以使用 `/**`之后回车自动出现作者信息的；现在用IDEA不能通过这种方式补全，非常不方便。

**注意**：网上很多教程，说的是新建java类的时候出现作者信息，跟提到的问题痛点是不同的!

> 作者信息是什么?

/**
     *
     * @author Stone
     * @date 2020/9/22
     */

#### 二、怎么解决? 设置LiveTemplate ####

##### 2.1 步骤 #####

1.  File->Settings->Editor->Live Templates
2.  点击右上角的加号，选择新建分组，用于包含自己新增的LiveTemplate，选择 `Template Group...`
3.  输入名字，例如 `MyCustomGroup`，点击`OK`
4.  选中新建的分组，点击右上角的加号，这次选择 `Live Template`
5.  输入Abbreviation（缩写，即用来触发的单词），以及Description（描述，会出现在提示框后侧，详见后图）。例如输入`zz`，描述是`作者信息`
6.  Template text中输入模板信息，如果带有变量，则自动检测到变量后右边的`Edit variables` 会亮起来  
    例如值：

/**
     *
     * @author Stone
     * @date $DATE$
     */

**注意**：变量的格式**不是** `${DATE}`，而是 `$变量名$`

1.  点击 Edit variables，输入Expression，用于告知要怎么取值，例如用 `date()`表示取当前日期，点击`OK`
2.  可以看到No applicable contexts，点击 Define，勾选Java全部
3.  最终点击OK

##### 2.2 过程图 #####

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

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

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

##### 2.3 验证是否设置成功 #####

配置好后，输入zz，会有提示，接着按tab键输出内容  
![在这里插入图片描述][20200922183844583.png_pic_center]

#### 三、IDEA设置：新建类时出现作者信息（不建议） ####

> 注意，这种设置方式只会在新建文件的时候出现作者信息。由于这里的设置风格和上述的设置风格可能不一致，所以强烈建议**不要设置这个**

举个例子，新建文件的风格是

/**
     *
     * @author Stone
     * @date 2020/9/22
     */

如果 LiveTemplate 中设置的风格是

/**
     *
     * @author Stone
     * @version 1.1.0
     * @date 2020/9/22
     */

则**两者风格不一样**，看起来比较强迫，建议只设置 LiveTemplate 就行了

##### 步骤： #####

1.  settings->Editor->File and Code Templates
2.  在 Includes->File Header 中添加如下

/**
     *
     * @author Stone
     * @date ${DATE}
     */

其中 `${DATE}` 是函数，自动取当天日期，有什么函数可以用，可以参考Description，如下  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3c4eTU2Zg_size_16_color_FFFFFF_t_70_pic_center 3]

#### 四、如果设置/\*\*作为快捷键 ####

前面的例子中我们设置`zz` 作为快捷键，其实我们是可以设置`/**`作为快捷键的

不过有个细节，设置快捷键为 `/**` 的时候，在输入 `/**` 之后并不会提示，而是需要使用代码补全的快捷键之后才会提示

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

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

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

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3c4eTU2Zg_size_16_color_FFFFFF_t_70_pic_center]: /images/20221123/0d7a5489257b4220ab77ae728ac69157.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3c4eTU2Zg_size_16_color_FFFFFF_t_70_pic_center 1]: /images/20221123/7831f9530eda4b5b8e67942a75bca9a0.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3c4eTU2Zg_size_16_color_FFFFFF_t_70_pic_center 2]: /images/20221123/2e6014b5eafd4af494ecb78b50de8ebc.png
[20200922183844583.png_pic_center]: /images/20221123/157a6dcb97564188a0d779660b1f3f76.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3c4eTU2Zg_size_16_color_FFFFFF_t_70_pic_center 3]: /images/20221123/437d7e5a8f3b426f82784aba8e5a14ee.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3c4eTU2Zg_size_16_color_FFFFFF_t_70_pic_center 4]: /images/20221123/4b7cf2ea4c3949f59ffd83e332b34317.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3c4eTU2Zg_size_16_color_FFFFFF_t_70_pic_center 5]: /images/20221123/fdecde6addce46bd880dc8a0dc3d3383.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3c4eTU2Zg_size_16_color_FFFFFF_t_70_pic_center 6]: /images/20221123/126f3fe0b38746ee97c42d40108476d1.png