IDEA 类、方法注释模板

虽然用的次数不多,但是每次用都要去网上找,然后修改成自己的,就简单保存下吧;

类的注释

1
2
3
4
5
6
7
8
9
/**
* ProjectName: ${PROJECT_NAME}
* ClassName: ${PACKAGE_NAME}.${NAME}
*
* @author payne.zhuang
* @description TODO
* @copyright (C), 2018 ChiGuaTeam
* @date ${YEAR}/${MONTH}/${DAY} - ${HOUR}:${MINUTE}
*/

方法注释

1
2
3
4
5
6
7
/**
* MethodName $title$
* description TODO
* @author payne.zhuang $param$
* @updateTime $date$ $TIME$ $return$
* @throws $throws$
*/

  1. date:如果不添加日期格式在表达式里,会使用系统设置的日期格式,可使用与Java语法里相同的语法输入日期格式,比如 date(“yyyy-MM-dd”);
  2. time:如果不添加时间格式在表达式里,会使用系统设置的时间格式,可使用与Java语法里相同的语法输入时间格式,比如 time(“HH:mm”)。
  3. params:

    1
    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())
  4. returns:

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

    1
    expresstionType(Expression)