解决IDEA添加方法注释

使用idea的时候,在方法前面使用/**加回车键可以自动注释方法的说明,但有时候需要我们修改默认的内容,目前在网上没有找到相应的方案解决在方法体外面配置注释模板的方案,只能自己动手解决这个问题了。

  1. IntelliJ IDEA–>Preferences–>Editor–>Live Templates,创建模板如下图
    解决IDEA添加方法注释_第1张图片
  2. 设置Edit variables
    解决IDEA添加方法注释_第2张图片
    解决IDEA添加方法注释_第3张图片
    其中params的变量代码如下
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());
  1. 在方法体前面输入/**+回车键进行测试,结果如下图,很明显上面这个结果不是我们想要的,红色框框的内容多出了/**
    解决IDEA添加方法注释_第4张图片
  2. 重新调整模版,如下图
    解决IDEA添加方法注释_第5张图片
    上图红框内去掉前面模板的/**,同时第一行的*要顶到最左边,继续在方法体前面输入/**+回车键进行测试,结果如下:
    解决IDEA添加方法注释_第6张图片
    现在基本上满足我们的要求了,不过每行的格式缩进仍在存在问题
  3. 继续打开模版配置,将Reformat according to style勾选上
    解决IDEA添加方法注释_第7张图片
    结果如下,问题终于解决了
    解决IDEA添加方法注释_第8张图片

PS:在一开始的时候老狼在下面这地方Abbreviation配置的是zz,结果发现只能在方法体内获取到参数和返回值,在方法体外是获取不到的。后来想为什么idea自带的/**快捷键就能在方法体外获取到参数,于是找遍了idea的配置文件都没找到在哪里设置的默认值,于是想了下将Abbreviation配置成跟系统一样的是否会覆盖,结果奇怪的现象是不但覆盖了系统的默认值,而且是继承了在方法体外获取参数的特性,完美解决老狼的问题,后面如果有朋友知道原理欢迎留言告知,谢谢
解决IDEA添加方法注释_第9张图片

你可能感兴趣的:(工具,idea,工具)