IDEA代码格式和JavaDoc设置，一键告别丑陋代码

概述

经常看到团队内部同事的代码格式很丑陋，有的代码一行很长很长，有的运算符前后没有空格，有的没有javadoc，各有各的特色，林林总总，导致代码阅读存在很大的阻碍。那么看了这篇文章，大家就不用担心了，通过IDEA的设置，可以一键格式化代码，每个人都给我装起来呀。

代码格式设置

1.进入插件界面：File->Settings->Plugins，搜索 eclipse code formatter，如已有插件则不需安装，如没有，点击Search in repositories自动搜索线上插件。

2. 导入codestyle.xml 点击OK

📎codestyle.xml

3. 依次点击进入插件界面：File->Settings->Editor->Code Style->Java->Import Scheme->Intellij IDEA code style XML，导入下面的ideacodestyle.xml
   

📎ideacodestyle.xml\

4. 完成，页面通过格式化，就会统一根据规定的格式进行格式化。

• 通过下面的按钮或者快捷键Ctrl+Alt+L 进行格式化

• 最重要的是，如果只想要格式化你修改部分的代码，记得选中然后进行格式化。

JavaDoc模板设置

本文档红色部分为需要修改为实际内容

类注释

示例：

/**
* <p>描 述：这个是将resourceId换成resourceVo的工厂类</p>
*
* @author: xx (xx@xx.com.cn)
* @date: ${DATE}  ${TIME}
* @version: 1.0.1
*/

IDEA设置：

在idea的setting->editor->file and code templates里面增加以下内容可在新增类时自动生成模板

/**
* <p>描 述：</p>
*
* @author: xx (@xx.com.cn)
* @date: ${DATE}  ${TIME}
* @version: 1.0.0
*/

方法注释

示例：

/**
 *<p>描述：</p>
 *
 * @param content 搜索内容
 * @param sort 搜索排序
 * @param gameTypeIds 搜索类型
 * @param years 搜索年份
 * @param page 页码
 * @param pageSize 每页个数
 * @param memberId 用户ID
 * @param token 用户token
 * @param onlyCollect 是否只展示收藏
 * @author xx (xx@xx.com.cn)
 * @date 2020/6/12 16:02
 */

IDEA设置：

1. 在idea的setting->editor->live templates里面新增一个模板，本例新增一个名为func对模板，并填入以下内容：

/**
*<p>描述：</p>
$params$
* @return $return$
* @author xx (xx@xx.com.cn)
* @date $DATE$ $TIME$
*/

2. 点击edit variables并按以下图示设置：

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

3. 配置完成以后，在需要生成注解对函数前面打 /fun并按tab键（具体根据自己的idea设置）可自动生成对应注解，并完善即可。

变量注解

示例：

/**
• 最后刷新时间
*/