526互联

Idea添加注释模板

发布时间 2023-09-27 19:41:05作者: 万里阳光号船长

先展示结果

在这里插入图片描述

具体步骤

  1. 选择导航栏的File -> Settings -> Editor -> Live Templates。
  2. 点击右边的加号，先创建一个Template Group（名字随意），选中创建的分组，再点击加号创建Live Template。
    在这里插入图片描述
  3. 在下方的Abbreviation中设置想使用的快捷键，我这里填的 ‘*’ 。Template text中填入如下模板信息，@Author后面跟姓名。
**
 * @Author name
 * @Description
 * @Date $time$ $date$
 $params$
 * @Return $return$
**/

在这里插入图片描述
4. 点击右边的按钮Edit variables，按如下内容设置
在这里插入图片描述
params行Default value列，填写如下脚本

groovyScript("def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++) {if(params[i] == '') return result; if(i > 0) result+=' '; result+='* @Param ' + params[i] + ((i < params.size() - 1) ? '\\n' : '')}; return result", methodParameters())
  1. 应用模板，点击下方Define，勾选Everywhere。右边的Expand with下拉框可以设置配合Abbreviation使用的快捷键（默认为Tab）。
    在这里插入图片描述
  2. 在方法上面敲快捷键使用。我设置的Abbreviation为 ‘*’，Expand with为Enter，使用时直接敲：/ + * + 回车。