前言
CheckStyle-IDEA是一個檢查代碼風格的插件,有助于提升代碼風格。
下載安裝
AS插件界面 File / Settings / Plugins
方式1:File / Settings / Plugins / Browse Responsitories 搜索 CheckStyle-IDEA
方式2:JetBrains 插件下載(要翻墻) 或者GitHub原址 Release ,下載之后在插件界面中選擇Install plugins from disk
,選擇下載的插件進行安裝。
一、配置Checker
默認有Sun和Google兩種check。當然你也可以添加自己的check,如下圖
添加Check.png
二、使用
在底部點擊開Check Style 項。比較蛋疼的是,無法對文件夾或者多個選定文件同時進行檢測。當然,可以配合針對修改過的文件也算一種較好的替代方式。
另外該插件還可以配合AS內(nèi)置的VersionControl使用,在提交代碼時候時候,對提交的文件進行檢測,有效地避免忘記檢查風格。
提交配置.png
三、定制
當然通常默認的check都不好使,比如Google Checks,用過就會發(fā)現(xiàn),太過嚴格,有時候我們不需要太強制性,比如一些JavaDoc的檢測等等,需要修改檢測規(guī)則。這里是Google Checks的過濾規(guī)則,你可以復制下來,并針對警告,找到對影響,把原規(guī)則注釋掉,就可以忽略這條規(guī)則了。但是注釋時候要注意,一定要使用這種單行注釋的形式,否則無法通過。
<!--<module name="SummaryJavadoc">-->
<!--<property name="forbiddenSummaryFragments"-->
<!--value="^@return the *|^This method returns |^A [{]@code [a-zA-Z0-9]+[}]( is a )"/>-->
<!--</module>-->
四、配合Style使用
為了更好配合插件,強烈建議使用使用相近的Code Style,在把代碼格式化代碼之后,可以大量減少風格問題。這里推薦使用Square JakeWharton,或Google Style的。
最后
Thanks