一、idea 中阿里巴巴代码规范插件的作用
1. 一套统一的准则
大家都用统一的、经过前辈检验总结后的准则,这样避免了代码整理时容易发生的争执。而且统一的注释规范,大家互相看着也方便。
2. 检测到不合规范的代码块会自动提示
if或者else没有添加大括号
接口方法必须要有注释
3. 在 idea 中能把部分代码通过 Alt + Enter 直接更正
if else注释.gif
添加作者注释.gif
4. 在 idea 通过配置注释快捷键可以快速给出符合规范的注释
接口的快速注释.gif
二、在 idea 中安装阿里巴巴代码规范插件
1. 打开 File --> Settings
搜索阿里巴巴插件
alibaba插件直接弹出来了
点击 Restart,关闭本页面,确认重启 idea
2. 设置注释快捷键
(1) 新创建文件时,在头部自动添加信息
新文件头部注释
/**
* @author 你的名字
* @date ${DATE} ${TIME}
*/
新创建的文件已经自动添加上注释了
(2) 配置快捷键注释 (关键)
a. 创建新的模板组
创建新的模板组
输入新的模板组的名字
在模板组中新增模板
b. 新的模板
**
* description:
*
$param$
* @return $return$
*/
填入新的模板的信息
param 填入的表达式
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())
idea的一个BUG,如果在复制 groovyScript() 的时候经常复制不上去,那么你需要在Expression中复制groovyScript() 后立即按 CTRL + S
配置变量
最后一步
到此,差不多都配置好了。
(2) 快捷键的使用
如果某个单词下方出现~~~代表不合规范,不严重的波浪线是浅黄色,严重的波浪线是红色。
可以把鼠标移到该单词上,看它提示啥信息。提示的信息对应着阿里巴巴 Java 编程规范。
也可以点击该单词,把光标位置移到波浪线出现的位置,然后 Alt + Enter,然后各种操作。
在接口的方法上 输入 /* 按下 Tab 键,注释就自动出来了
接口的快速注释.gif
有问题欢迎评论,希望对你有帮助。
完。