idea中设置代码注释（多个参数分行显示、参数字段不对齐问题解决）

一、问题

在设置idea注释过程中碰到过参数不分行显示、参数字段不对齐还有参数字段即使对齐了之后写入注释过程中变得不对齐，经过参考多篇文章终于解决这些问题，为此记录下来。

二、设置代码注释步骤

1、步骤一

点击file->setting，找到editor下的Live Templates

点击右上角加号按钮，选择Template Group

输入group name，比如我输入的是personal，点击ok完成新建

随后选择新建的Template Group，点击右上角加号按钮，点击新建Live Template，表示在当前组下新建模板，By default expand with这里选择Enter，表示注释时候输入/*然后按下Enter触发该模板。

2、步骤二

先点击左下角Define按钮

找到java选项并勾选上

在Abbreviation中填入*，Template text：中填入如下代码，勾选Reformat according to style和Shorten FQ names，Description中是对该模板的描述可以不写

**
 * @description $context$
 * @Date $date$ $time$
$params$
 * @Author $author$
 * @return: $return$
 */

注意：格式就是这样，没有错误，第一行是**，没有/，也不要加，$params$也不要和其他的对齐，具体原因未知。
作者这一栏中$author$是自动引用idea中的用户名，通过下面所选择的user()方法起到作用的，其实也可以直接定义好@Author 张三

3、步骤三

最后点击Edit Variables按钮

选择各个对应的方法

params选项对应的Default value为（作用是让多个参数分行），这个要勾选Skip if defined

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())  

其中Skip if defined表示是否跳过，比如时间、作者是自动生成的，不需要我们修改了，我们就选择跳过，这样在写注释时候光标就不会自动跳到时间、作者上面去
最后点击OK保存即可

4、测试

在方法上输入/*按下Enter出现如下模板

其中光标停留在descripton中，可以直接输入，这就是Skip if defined起到的作用