IDEA自定义注释

注释模板配置

1. 首先打开 IDEA 设置 Settings...(Windows 快捷键：Ctrl + Alt + S，Mac 快捷键：command + ，）---> Editor ---> Live Templates ---> 点击右侧加号 "+"

   

2. 设置以下六处相应的内容

   

• Abbreviation:
  快捷缩略词，可以输入数值、字母、符号，到时配合 /* 使用（依模板内容而定），例如你输入一个，那么到时候输入 / 回车即可，以下为本人设置内容 *

• Description:
  实时模板的说明文字，提示显示用

  java方法注释快捷操作
  

• Template text:
  模板内容，即自定义注释展示内容

  *
   * -------------------------
   * @Description: 
   * @Author: codingSh1t
   * @Date: $date$ $param$ $return$
   * @UpdateLog: Description Author Date
   * -------------------------
   */
  

• Options:
  其他参数，包括格式化、展开方式等

  Expand with选择Enter，勾选Reformat according to style和Shorten FQ names
  

• Change(第一次设置是Define):
  应用于哪个位置，由于此次操作为 Java，固只在 Java 前挑勾应用

  勾选Java下的Comment
  

• Expand with:
  展开方式：默认选Enter就行

• Edit variables：
  编辑变量按钮，参数设定为：
  param：

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

  return:

  groovyScript("def result=''; def data=\"${_1}\"; def stop=false; if(data==null || data=='null' || data=='' || data=='void') { stop=true; }; if(!stop) { result += '\\n'; result += ' * @return ' + data; }; return result;", methodReturnType())
  

  date:

  date("yyyy/MM/dd HH:mm")