本文中使用intelliJ IDEA版本為14.0.1,其他版本差異不大,可同樣安裝。
下載安裝CheckStyle-IDEA插件
安裝該插件有兩種方式,在線安裝和安裝包安裝
(1) 在線安裝
File->Setting->Plugins至下圖界面,搜索CheckStyle-IDEA,點擊安裝。
(2)安裝包安裝
解壓附件中checkstyle-idea-4.10.0.zip,將CheckStyle-IDEA文件復制到IntelliJ IDEA 14.0.1安裝目錄下的plugins文件夾中。
安裝完成后,重啟IntelliJ IDEA使插件生效。
配置checkstyle
File->Setting->Other Setting->checkStyle至下圖界面
點擊紅框選中的綠色加號至上層頁面添加自定義的檢查規則,選擇附件中的my_checks.xml,Next,Finish后至下圖。
選中新添加的檢查規則,並Apply即可。
使用checkStyle檢查文件
在File->Setting->Editor->CheckStyle中選擇是否進行實時檢查。
(1) 實時檢查,實時地對不規范的書寫進行提示 ,並在編輯頁面中進行顏色標識。
(2) 取消實時檢查后,可在打開的文件中右擊選擇Check Current File對當前頁面進行檢查,此時可在下圖所示的CheckStyle Scan 中查看不規范內容,點擊條目可查看對應出錯語句。
其他
如有一些必須的但不符合檢查規則的地方需要忽略檢查可以按照下述進行注釋
// CSOFF: MagicNumber
需要忽略的代碼段
// CSON: MagicNumber
其中MagicNumber為檢查的一個步驟,表示檢查魔法數,可以替換成其他的檢查步驟,比如要忽略該段的行長度,可將MagicNumber改為LineLength即可。