关于Idea的注解配置

野性酷女 2022-02-18 10:11 248阅读 0赞

**目录**

1.Class自动生成注释

2.方法、通用注释

方法注释

通用注释

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

## 1.Class自动生成注释 ##

Settings > Editor > File and Code Temlpates > Class/Interface/Enum/..

注释模板：

#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end
    #parse("File Header.java")
    /**
      * @Description TODO
      * 
      * @Author  User Name
      * @Date ${DATE} ${TIME}
      *
      **/
    public class ${NAME} {
    }

图：![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MjEzOTc1Nw_size_16_color_FFFFFF_t_70][]

创建新Class的时候会自动加载：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MjEzOTc1Nw_size_16_color_FFFFFF_t_70 1][]

类的注释是创建的时候自动生成的，大同小异，可以根据需求自己配置；

## 2.方法、通用注释 ##

Settings > Editor > Live Templates

右侧'+'，Live Template 添加单独模板，Template Group 添加用户模板组

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MjEzOTc1Nw_size_16_color_FFFFFF_t_70 2][]

在这里添加模板组方便管理，然后添加 Live Temlpate。具体方式如下：

### 方法注释 ###

创建：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MjEzOTc1Nw_size_16_color_FFFFFF_t_70 3][]

Abbreviation：设置快捷符（缩写），根据自己习惯设置。我这里为9（下有图）

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MjEzOTc1Nw_size_16_color_FFFFFF_t_70 4][]

Description：说明，自由定义

Template text 注释模板（$参数$可以自定义）：

/**
     * @Author $user$
     * @Description //TODO $end$
     * @Date $time$ $date$
     * @Param $param$
     * @return $return$
     **/

接着在右侧Edit variables里设置参数获取方式：

Expression设置表达式获取参数，这里有自带的方法，也可以使用脚本

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MjEzOTc1Nw_size_16_color_FFFFFF_t_70 5][]

比如：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MjEzOTc1Nw_size_16_color_FFFFFF_t_70 6][]

然后修改下面的参数获取方式（提示No applicable contexts yet后面）.点击Define，选择需要的：

![20190417113900536.png][]

![20190417110447915.png][]

设置好以后在方法里使用9+回车即可

![20190417114655489.png][]

这里的@Author是系统用户名，而且@Param在方法外的时候获取不到参数

后面上按照自己习惯配置，也可以在方法外获取参数：![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MjEzOTc1Nw_size_16_color_FFFFFF_t_70 7][]

这里这样写，根据配置可以在方法外获取参数：

**
     * @Description //TODO $end$
     $param$
     * @return 
     **/

param这里由于方法限制，没办法在方法外获取参数，所以设置脚本，在方法外获取参数需要输入/\*：

groovyScript("def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++) {result+='* @param ' + params[i] + ((i < params.size() - 1) ? '\\n ' : '')}; return result", methodParameters())

直接粘贴进去：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MjEzOTc1Nw_size_16_color_FFFFFF_t_70 8][]

使用

比如方法service：

![2019041711115059.png][]

在方法上输入/\* 按tab：

![201904171112183.png][]

自动生成，@param后面也有参数：

![20190417111303906.png][]

使用//TODO比较明显

![20190417111412489.png][]

### 通用注释 ###

通用注释更方便一点，只是按照自己设置的习惯就行了

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MjEzOTc1Nw_size_16_color_FFFFFF_t_70 9][]

比如这里只需要按/+回车就可以打出来，十分方便

![20190417112004132.png][]

回车：

![20190417112013650.png][]

不过想换行的时候对于行末的/进行回车就不太友好了，所以这里还是根据个人喜好设置吧。

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MjEzOTc1Nw_size_16_color_FFFFFF_t_70]: /images/20220218/63337f101fa24eaca0bee5da1bdc3370.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MjEzOTc1Nw_size_16_color_FFFFFF_t_70 1]: /images/20220218/1f6d1e580df0420192349b943958ed74.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MjEzOTc1Nw_size_16_color_FFFFFF_t_70 2]: /images/20220218/9d454def94ff4d71a0e59be826c28f67.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MjEzOTc1Nw_size_16_color_FFFFFF_t_70 3]: /images/20220218/750fbad525a94ff8a85c4f8e4805749e.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MjEzOTc1Nw_size_16_color_FFFFFF_t_70 4]: /images/20220218/8b5f3ab0f28248f4b7606c0824c0a21d.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MjEzOTc1Nw_size_16_color_FFFFFF_t_70 5]: /images/20220218/e67a482e97324b5b82ae3b265a0b2180.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MjEzOTc1Nw_size_16_color_FFFFFF_t_70 6]: /images/20220218/7fe11c52d533442895c7c2f026a32ccc.png
[20190417113900536.png]: /images/20220218/8064bbe93cab4d64b089a1c863e7ab8d.png
[20190417110447915.png]: /images/20220218/8fc037ba40654b45af3a24ab329d3315.png
[20190417114655489.png]: /images/20220218/af2986b8a7974c82966b9bb6328e8431.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MjEzOTc1Nw_size_16_color_FFFFFF_t_70 7]: /images/20220218/8008a18323bf42e9865e731263da187b.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MjEzOTc1Nw_size_16_color_FFFFFF_t_70 8]: /images/20220218/e6a6097354b048028970204cdccaa504.png
[2019041711115059.png]: /images/20220218/f638304e4f014348ac15eb18ffc84733.png
[201904171112183.png]: /images/20220218/a5c45dd93fb4436eb3f796baed38620e.png
[20190417111303906.png]: /images/20220218/3446fa62e6e2457cb47017aa97e27c37.png
[20190417111412489.png]: /images/20220218/02242d29711241be9f4b80152e726007.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MjEzOTc1Nw_size_16_color_FFFFFF_t_70 9]: /images/20220218/941e29ca8d6c44249787967efaa98f40.png
[20190417112004132.png]: /images/20220218/9a0fa522d89d476680a6a7a00056a12f.png
[20190417112013650.png]: /images/20220218/c717547a6e7d4f799fa84ebcbb7b247b.png