统一自定义idea和eclipse代码格式化和注释格式化总结

公司统一规范代码格式化和注释规范化，在此统一整理了idea和eclipse的配置，用于统一管理。下面逐一介绍两个IDE平台的相关配置和用法。

1.Eclipse平台的代码格式化

eclipse的代码格式化比较简单，只需将其格式化配置直接导入。格式化文件可以根据google的样式导入然后修改对应的参数设置即可。然后将设置的自定义格式导出，大家使用导出的文件统一覆盖对应的Formatter设置。这样，使用Eclipse平台的样式就统一了。

2.Eclipse平台的注释格式化

eclipse注释格式化也是更改其对应的注释模板，即Code Templates设置。其位置为：Windows->Preferences->Java->Code Style->Code Templates的设置。注释模板在创建文件时自动生成对应注释，也可以使用注释快捷键生成（/**加Enter）。这里只配置了Comments，具体如下：

2.1 Files项

/** Copyright(C) 2013-${year} XXX公司 Inc.ALL Rights Reserved.** @version v1.0* @description * @author ${user}* @date ${currentDate:date('yyyy-MM-dd HH:mm:ss')}* */

2.2 Types，Files项

/** @description * @author ${user}* @date ${currentDate:date('yyyy-MM-dd HH:mm:ss')}* */

2.3 Constructors，Methods 项

/** @description * @author ${user}* @date ${currentDate:date('yyyy-MM-dd HH:mm:ss')}* ${tags}* */

2.4 Overriding Methods 项

/** @description * @author ${user}* @date ${currentDate:date('yyyy-MM-dd HH:mm:ss')}* ${see_to_overridden}* ${tags}* */

2.5 Delegate Methods 项

/** @description * @author ${user}* @date ${currentDate:date('yyyy-MM-dd HH:mm:ss')}* ${see_to_target}* ${tags}* */

2.6 Getters/Setters 全置空，可以使用Methods的注释模板。

3.IDEA平台的代码格式化

idea只需要下载一个插件EclipseFormatter，安装即可（注意避免与idea的本身代码风格冲突，建议使用默认设置，其他的格式化插件建议不启用或卸载，如google-java-format） ,然后启用该插件配置，应用eclipse的代码格式化文件。eclipse的启用选项可以根据实际效果选择，一般是4.4。

4. IDEA平台的注释格式化

注释格式化一般也是在File and Code Templates 中定义，在Live Templates中可自定义方法注释模板；IDEA中的模板注释设置与Eclipse有些不一样，可参考https://blog.csdn.net/lantazy/article/details/76890313

4.1 在 Includes中修改 File Header

/** Copyright(C) 2013-${YEAR} XXX公司 Inc.ALL Rights Reserved.** @version v1.0* @description * @author ${USER}* @date ${YEAR}-${MONTH}-${DAY} ${TIME}* */

4.2 在Files中分别头部修改Class、Interface、Enum如下：

#parse("File Header.java")#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end/*** @description * @author ${USER}* @date ${YEAR}-${MONTH}-${DAY} ${TIME}**/

4.3 自定义方法注释模板

在idea中，我们可以自定义快捷键注释，注释风格和参数均可以在Live Templates中设置，如定义的my comment注释快界面，主要步骤如下：

1) Live Templates选中后点击+，添加Template Group ，设置名称为CodeDescription;

2) 选中CodeDescription，点击+，添加 Live Templates ，设置Abbreviation 名称为my ，Description 填自定义注释， Template text 如下：

/*** @description * @author $user$* @date $date$ $time$* $param$* @return $return$**/

3) 点击Edit variables设置对应模板值获取函数。（可参考https://www.cnblogs.com/silentercn/p/9782230.html）在Name中填写user ，Expression中填user()，默认值随意或不填；追加在Name中填写date ，Expression中填date("yyyy-MM-dd")；追加在Name中填写time，Expression中填time("HH:mm:ss")；追加在Name中填写return，Expression中填MethodReturnType()；追加在Name中填写param ，Expression中填

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

4)设置完成后可以在idea的任意位置使用快捷键my，然后自动弹出注释内容，建议在方法内部使用，这样就可以获取方法的所有参数了，然后拷出即可。

5.IDEA的一些重要的配置项

5.1 配置激活工具

参考：https://blog.csdn.net/qq_41983010/article/details/82562975

5.2 配置日常小技巧

参考：https://www.cnblogs.com/shindo/p/7243771.html

5.3 配置运行空间和处理控制台乱码

打开 IDEA 安装目录，看到有一个 bin 目录，其中有两个 vmoptions 文件，需针对不同的JDK进行配置，32 位：idea.exe.vmoptions，64 位：idea64.exe.vmoptions，全局：idea.exe.vmoptions，修改其需要的部分即可。具体可以参考网络配置：https://www.cnblogs.com/yingsong/p/5896207.html

    -Xms1024m  -Xmx2048m  -XX:MaxPermSize=1024m  -XX:ReservedCodeCacheSize=1024m  -Dfile.encoding=UTF-8

5.4 将idea的运行空间配置文件放置到自定义目录（默认是c盘的），安装完成后，修改配置文件idea.properties中的配置项。

# idea.config.path=自定义目录idea.config.path=D:/workspace/idea-config/config
# idea.system.path=自定义目录idea.system.path=D:/workspace/idea-config/system