【idea】idea方法注释

网上有很多类似的文章，但是我在按照他们的文章设置后，出现了一些问题，因此我这边在解决了问题后，总结一篇文章，发出来给大家借鉴一下。在此先说明一下idea的版本，是2020.1.3

设置动态模板，File->Settings->Editor->Live Template

点击右上角的+号，添加动态模板组Template Group，再添加动态模板Live Template

abbreviation意为缩写，如我们设置为mc(Method Comment，方法注释的意思)。

注意，在使用注释时是/mc，但是这里的名字，要设置为mc，不能带斜杠的，否则注释快捷键会无法正常使用。

模板文本template text如下，注意开头不要带斜杠，author后面改成你自己的名字：

**
 * @author gengzhihao
 * @date $date$ $time$
 * @description $description$
 $params$
 $returns$
 */

注意，上面的模板和别的文章里的不太一样，是因为我自己做了一些改动。别的文章里的模板，使用注释需要 / 加上 星号或者2个星号，再加上缩写，最后Tab补齐，才能产生注释。我这个模板，可以省略掉加上星号的过程。

编辑动态注释要使用的地方

只选择Java相关的

点击右侧的edit variables，值的表达式建议用下面的表达式，因为idea自带的这个methodParameters()函数只是将参数作为一个列表呈现出来，不方便对每一个参数进行解释

需要注意的是，要把后面的skip if defined✓起来。如果不✓的话，就是产生注释后每一项都要回车确认；打✓的话， 就是已经有值的就会默认自动确认，不需要手动确认，更方便省事。

edit vatiables中，param和return值依次如下[1]：
param

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) ? '\\r\\n ' : '')}; return result == '' ? null : result", methodParameters())

return

groovyScript("def returnType = \"${_1}\"; def result ='';if(returnType=='null'||returnType=='void'){return;}else{result += '* @return ';cls = returnType.split('<');for(i = 0; i < cls.size(); i++){temp = cls[i].tokenize('.');result += temp[temp.size() - 1] + ((i < cls.size() - 1) ? '<' : '');};return result + ' ';}", methodReturnType());

注意，使用方法注释的方式是 /+动态模板缩写(如mc)+Tab补齐[2,4]。必须是斜杠加上abbreviation缩写的名字如本文中的mc，加上设定的补齐键（默认Tab），任意处不对都会导致无法正常产生注释。

此外，一定注意复制模板的时候，第一行是2个*。如果是一个*，就需要在使用注释时的斜杠后自己加一个*才行。因此一定要完整复制模板。

注释效果如下，可以看到对于方法列表有多个入参也能有比较好的效果：

模板文本这部分设置是你期望的注释格式，诸如$date$是能被idea识别的占位符，在右侧的edit variables中能够编辑这些占位符对应的值。不过在具体的使用中，使用idea自带模板和groovy表达式的时候，模板中是否带有@param@return，是有细微的区别的，这一点读者可以自行验证。

类注释需要的参数一般没有方法参数多和复杂，一般带个author和时间就好，也就是说用方法注释模板改一下就能用。

参考文章：
[1]，IDEA设置方法注释模板
[2]，idea设置方法注释(亲测有效)
[3]，IDEA设置自定义注释快捷键
[4]，超级详细的IDEA设置Java类和方法的注释模板