IDEA 自定义注释模板


之前每次添加注释模板的时候,都会去网上查一遍,但是每个人写的教程都不一样,出现注释模板百花齐放,因此在这里记录下自己认为比较好的一套模板,适应@JavaDoc编写的,支持多参数分别列出的一套模板,下面首先介绍下自定义模板组和模板的创建过程

创建模板组

  1. 首先第一步打开Idea的Setting界面,步骤:打开Idea–>菜单选择File–>选择Setting
  2. 不再描述,自己看图吧 需要说明的几点:
  • 上图中的Abbreviation是调起注释的快捷输入内容,再加上Expand with中选择的快捷键(个人使用的是Tab,看个人喜好进行选择,可选择Enter)
  • 上图中最下面有一排小字,显示最末尾有个Change,是选择注释快捷输入的作用域,也就是在什么地方你可以通过快捷字母进行输入,这个地方是可以修改的,默认的时候这个地方显示的是No Applicable context yet.Define,点击打开可以选择作用域,我这里选择的是Java,也可以选择第一个,全部选择,如果不选的话,在变量编辑界面会出现系统提供下拉选择变量没有的情况
  • 模板框中一定得现有内容,例如下面的代码注释模板,否则Edit variables按钮是不可点击状态的

    1
    2
    3
    4
    5
    6
    7
    8
    9
    /**
    *
    *
    $params$
    * @return $returns$
    * @exception $exception$
    * @author $author$
    * @date $date$ $time$
    */
  • 上面的变量配置截图和内容如下

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    params: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) ? '\\r\\n' : '')}; return result", methodParameters())

    returns:methodReturnType()

    exception:expressionType(Expression)

    author:user()

    date:date()

    time:time()

变量录入完的效果见下图,这个地方有个比较奇怪的地方,在输入groovy代码的时候会出现切换后变成空的,这里可以输入完之后,直接点击OK,就能够保存下来了

0%