直接上图,展示效果
1.自定义注释方法步骤:按照下面的方法设置即可
第一步,选择File -> setting
第二步,选择Editor -> Live Templates
第三步,点击 + 号 -> 选择第二项Template Group, 至于By default expand with那里可以根据自己习惯,选择Enter或者Tab,他们区别在于,在方法生成注释时,按回车还是Tab(假设选择Enter时,在方法生成注释操作为 /* + 模板名,然后按键盘回车键,同理设置Tab,则是按键盘Tab键)
第四步,选择Template Group后,在弹窗中输入自己定义的模板名
第五步, 选中刚新增的模板,点击‘+’,选择第一个(Live Template)
第六步,点击上述步骤后,会展示如下图,
注释复制可以直接用
*
* 功能描述:
*
$param$
*
* @return $return$
* @auther $user$
* @date $date$ $time$
*/
第七步,点击上图Define,
第八步,点击下图中Edit variables
点击后,弹出窗口,按如下选择return、user、date等相关参数(点Expression中单元格,出现下拉选), param不要使用idea提供的
第九步,这里也是最重要的一步,网上很多设置,要么就是不展示自定义参数,要么就是展示有问题,比如出现下图这样的
问题出现在param选项,网上很多使用的groovyScript(“def result=’’; def params=”KaTeX parse error: Can't use function '\"' in math mode at position 5: {_1}\̲"̲.replaceAll('[\…{_1}".replaceAll(’[\\[|\\]|\\s]’, ‘’).split(’,’).toList(); result+=’* @param ’ + params[0] + ‘\n’;for(i = 1; i < params.size(); i++) {result+=’ * @param ’ + params[i] + ((i < params.size() - 1) ? ‘\n’ : ‘’)}; return result", methodParameters()) ,这两种都会出现上图问题,正确的应该使用,如下代码,直接粘到param参数设置中,
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())
如图
点击确定即可,最后在需要加注释的方法上使用 */abb -> 回车,如果在By default expand with不是设置回车键,记得使用自己设置的键位哦