IDEA方法注释模板设置

• 目录

  创建模板

  新建模板：命名为*

  设置模板内容-IDEA格式模板

  设置模板应用场景

  设置参数

  ---

  创建模板

/**+Enter这里我们也按照这种习惯来设置IDEA的方法注释：File-->Settings-->Editor-->Live Templates

先新建模板组，然后在模板组中新建注释模板

新建模板：命名为*

设置模板内容-IDEA格式模板

注意第一行，只有一个*而不是/*
在设置参数名时必须用${参数名}$的方式，否则读取不到你设置的参数名

** @Description $end$* @Author lei* @Date $time$ $date$$param$$return$**/

设置模板应用场景

点击模板页面最下方的警告，来设置将模板应用于那些场景，一般选择EveryWhere-->Java即可

设置参数

JavaDoc格式的需要自定义参数以及返回值的实现方式
获取参数实现方式：

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

返回值实现方式：

groovyScript("return \"${_1}\" == 'void' ? null : '* @return {@link ' + \"${_1}}\"", methodReturnType())