idea设置阿里代码格式规范及配置快捷键生成注释

本文配置快捷键生成注释部分转自：https://blog.csdn.net/x541211190/article/details/105816444，感谢大佬！！

一、代码模板配置

1.下载阿里代码格式化模板

https://github.com/alibaba/p3c/blob/master/p3c-formatter/eclipse-codestyle.xml

2.idea配置eclipse插件

插件名称： Adapter for Eclipse Code Formatter

安装操作路径：File->Settings->Plugins->Marketplace->search->Installed

3.配置代码格式

配置路径：File->Settings->Adapter for Eclipse Code Formatter

将代码格式化文件eclipse-codestyle.xml，配置到插件中

4.使用

（1）格式化部分代码

选中需要格式化的代码，快捷键：ctrl+alt+L

（2）格式化整个文件

在需要格式化的文件中，快捷键：ctrl+alt+L

（3）格式化整个项目**（慎用）**

idea中，项目上右键->Reformat Code

5.配置创建类、接口、枚举时自动生成注释

配置路径：File->Settings->Editor->File and Code Templates->Files

原本配置不用调整，添加注释部分即可

类->Class

/**
 * @description ${description} 
 * @author Hanson
 * @date ${YEAR}/${MONTH}/${DAY} ${HOUR}:${MINUTE}
**/
public class ${NAME} {
}

接口->Interface

/**
 * @description ${description} 
 * @author Hanson 
 * @date ${YEAR}/${MONTH}/${DAY} ${HOUR}:${MINUTE}
**/
public interface ${NAME} {
}

枚举->Enum

/**
 * @description ${description} 
 * @author Hanson
 * @date ${YEAR}/${MONTH}/${DAY} ${HOUR}:${MINUTE}
**/
public enum ${NAME} {
}

注释类型->AnnotationType

/**
 * @description ${description} 
 * @author Hanson 
 * @date ${YEAR}/${MONTH}/${DAY} ${HOUR}:${MINUTE}
**/
public @interface ${NAME} {
}

6.配置快捷键自动生成方法注释

一.打开实时模板，新建模板组

1. 依次点击：【File】-->【settings】-->【Editor】-->【Live Templates】，点击右上角的+号后， 选择Template Group。

2. 在弹出框中，随意输入个英文名：Method Comment（名字随便起，不要和系统的冲突即可），点击ok

   

二.创建实时模板

1. 必须单击选中上一步骤中创建的模板组Method Comment，然后再次点击右上角的+号，选择live Template。
   

2. Abbreviation文本框输入m（该项为快捷键，自行设置即可）。

   此处定义的是创建日志的快捷键，在方法上面一行，输入/m + 回车，会自动生成注释模板，可以根据自己的喜好定制快捷键。

3. Description中随意输入个描述即可，对配置无任何影响。

4. Template Text文本框中输入以下模板（关键步骤，十分重要）。

   **
    * @description TODO
    * @author Hanson
    * @date $time$
   $params$
    * @return $returns$
    */
   

   模板首行开头是没有/，为何这样定义模板？
   这样定义模板，是因为我们要通过/和上文 Abbreviation设置的快捷键，组合在一起使用，作为触发模板的快捷键。只有当输入了/后，再输入我们自定义的 Abbreviation中的快捷键x,才能触发注释我们自定义的注释。这样在写代码时，输入x的时候，弹出的候选项中是不会有注释模板的，不会干扰我们正常写代码。如下图，我们输入x,提示框不会包含注释模板。这样的好处是，自定义注释模板不会侵入正常编码（不需要写注释的时候，不会在弹框中提示）。
   其次，这样定义模板，能解决入参和返回值为空问题，如果在模板首行开头加入/,则生成的模板中，将可能获取不到入参值和返回值，可能会显示为null。

5. 点击底部的Define或Change按钮，在弹出的复选框列表中，勾选Java或者只勾选Java下的 other

   只勾选other的效果，在写java代码时，在声明方法时候，输入/m + 回车(上文设置的快捷键)，可以弹出注释模板，在其他位置不弹出，比如在方法体内、在类名上输入/x+ 回车，都不会生成模板。如果全选java，在Java代码的任意位置输入/m + 回车，都可以生成模板。我们生成方法注释的使用场景，当然是当鼠标在方法体上面一行闪烁的时候，才会使用；鼠标在其他位置闪烁时，我们是不需要添加方法注释的，所以建议只勾选other,来控制这一效果。
   

6. Expand with 下拉框中，选择Enter。
   输入完快捷键/m后，再按回车键Enter，即可自动生成注释模板。而系统默认是Tab键。经测试后发现，不设置此选项，按回车Enter也生效。

三.编辑变量

1. 点击右侧Edit variables，参考下图，输入下列参数即可。
   注： 弹出框中的参数，是由上文中Template Text 中的参数控制，你可以在模板代码中调整参数。

   time 和 returns 手动选择idea自带参数date() 和 methodReturnType() 即可。

   params 对应配置为groovy语言表达式

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

2. 点击ok，关闭编辑变量窗口。再点击Apply和ok关闭设置窗口，至此配置完成。

3. 在java代码中的方法体上一行单击后，输入/m会弹出提示框，第一个选项m就是我们自定义的方法注释模板，再按回车键Enter,就可以自动生成代码模板了。

• 设置类注释与设置方法注释类似，此处设置是方便在类中直接快捷键生成注释，方便拷贝后修改使用

1.Abbreviation文本框输入c（该项为快捷键，自行设置即可）。

2.Template Text文本框中输入以下模板。

**
 * @description TODO
 * @author Hanson
 * @date $date$ $time$
 */