IDEA文件注释模板

效果图

文件注释模板

1. 首先看看我们常用的创建.java文件时自动生成包名和文件名的模板，选择File→Settings→Editor→File and Code Templates→Files→Class，其中File Header.java表示作用于.java文件。Files右侧Includes有File Header文件。
   
2. File Header就是创建文件时的注释模板，加入自己需要的注解即可。右下角Description有配置参数说明。(其中${USER}获取的系统用户名，建议直接写固定值)
   

方法注释模板

1. 创建自定义模板分组。进入File→Settings→Editor→Live Templates，点击右上角加号，选择Template Group…
   
2. 创建模板。选中刚刚创建好的模板分组，点击右上角，选择Live Template。其中
   

   • Abbreviation: 为自定义模板名称，我这里定义的是method

   • Expand with: 填注释模板的扩展快捷键，根据使用习惯，这里使用默认的Tab

   • Template text：填写注释模板的内容。参数名使用$参数名$的格式。（注意：注释模板开头的/不要填写，因为设置后会出现param为null的情况（原因暂时未知），需要在方法内调用才能获取参数，但这样还需要将注释复制到方法外很不方便）
     内容为：

     **
      * @description 
      * @author username
      * @created Date $date$ $time$
      * @modified By
      * @modified Date
     $params$
     $returns$
      */
     

   • Edit variables 用于对Template text中的变量进行赋值。
     
     其中涉及到的参数值为：
     date值为：

     date("yyyy/MM/dd")
     

     time值为：

     time("HH:mm:ss")
     

     params值为：

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

     returns值为：

     groovyScript("def returnType = \"${_1}\"; def result = ' * @return ' + returnType; return result;", methodReturnType());