一、idea 中阿里巴巴代碼規(guī)范插件的作用
1. 一套統(tǒng)一的準則
?? 大家都用統(tǒng)一的分苇、經(jīng)過前輩檢驗總結后的準則栏赴，這樣避免了代碼整理時容易發(fā)生的爭執(zhí)。而且統(tǒng)一的注釋規(guī)范靖秩，大家互相看著也方便须眷。
2. 檢測到不合規(guī)范的代碼塊會自動提示
if或者else沒有添加大括號
接口方法必須要有注釋
3. 在 idea 中能把部分代碼通過 Alt + Enter 直接更正
if else注釋.gif
添加作者注釋.gif
4. 在 idea 通過配置注釋快捷鍵可以快速給出符合規(guī)范的注釋
接口的快速注釋.gif
二、在 idea 中安裝阿里巴巴代碼規(guī)范插件
1. 打開 File --> Settings
搜索阿里巴巴插件
alibaba插件直接彈出來了
點擊 Restart沟突，關閉本頁面花颗，確認重啟 idea
2. 設置注釋快捷鍵
(1) 新創(chuàng)建文件時，在頭部自動添加信息
新文件頭部注釋
/**
* @author 你的名字
* @date ${DATE} ${TIME}
*/
新創(chuàng)建的文件已經(jīng)自動添加上注釋了
(2) 配置快捷鍵注釋 （關鍵）
a. 創(chuàng)建新的模板組
創(chuàng)建新的模板組
輸入新的模板組的名字
在模板組中新增模板
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() 的時候經(jīng)常復制不上去扩劝，那么你需要在Expression中復制groovyScript() 后立即按 CTRL + S
配置變量
最后一步
到此，差不多都配置好了职辅。
(2) 快捷鍵的使用
- 如果某個單詞下方出現(xiàn)~~~代表不合規(guī)范棒呛，不嚴重的波浪線是淺黃色，嚴重的波浪線是紅色域携。
- 可以把鼠標移到該單詞上簇秒，看它提示啥信息。提示的信息對應著阿里巴巴 Java 編程規(guī)范秀鞭。
- 也可以點擊該單詞趋观，把光標位置移到波浪線出現(xiàn)的位置扛禽，然后 Alt + Enter，然后各種操作拆内。
- 在接口的方法上 輸入 /* 按下 Tab 鍵旋圆，注釋就自動出來了
接口的快速注釋.gif
有問題歡迎評論，希望對你有幫助麸恍。
完。
