編碼規範系列(二):Eclipse Checkstyle配置

上一篇介紹了《編碼規範系列(一):Eclipse Code Templates設置》,這篇主要介紹Eclipse中Checkstyle的配置。關於Checkstyle,引用百度百科的介紹如下:CheckStyle是SourceForge下的一個項目,提供了一個幫助JAVA開發人員遵守某些編碼規範的工具。它能夠自動化代碼規範檢查過程,從而使得開發人員從這項重要,但是枯燥的任務中解脫出來。CheckStyle檢驗的主要內容包括:Javadoc註釋、命名約定、標題、Import語句、體積大小、空白、修飾符、塊、代碼問題、類設計、混合檢查。

如果我們想要使用Checkstyle,首先必須在Eclipse中安裝Checkstyle插件,關於插件的安裝教程網上到處都是,在這裏就略過了。下面主要講一下Checkstyle的配置。具體步驟如下:

1.在Eclipse中打開Windows-->Preferences-->Checkstyle,如下圖所示:

Checkstyle配置

通過界面我們可以發現,Checkstyle插件中默認內置有2個執行代碼檢查的配置文件:Sun Checks、Sun Checks(Eclipse)。這兩個配置文件中分別定義了Checkstyle需要檢查的選項配置。一般項目組都會根據項目需求自定義一個配置文件,然後通過import的方式導入到Eclipse中。今天,我們主要介紹這一種方式。

2.點擊New,在彈出的界面中Type下拉框選擇External Configuration File,然後引入我們自定義的配置檢查xml文件,Name可以自定義,如下圖所示:

Checkstyle配置

點擊OK保存,然後我們在前一個界面中就能看到我們剛剛導入的配置了。就是下圖中的chenzhou_checkstyle

我們可以鼠標選中該行,然後點擊右邊的Set as Default按鈕,這樣Checkstyle就已經配置好了。

 

配置好了Checkstyle,我們還需要單獨在項目中激活Checkstyle檢查,具體方法爲:

右鍵點擊項目-->Properties-->Checkstyle,在彈出的界面中選中Checkstyle active for this project前的複選框,同時在Configure欄選中我們自定義的配置chenzhou_checkstyle,如下圖所示

點擊OK保存後項目會rebuild,這樣Checkstyle檢查就已經激活了。

我們可以打開我們的代碼,如果代碼中有不符合Checkstyle定義的規範的地方,Eclipse會黃色高亮顯示,如下圖所示:

如果我們把鼠標懸停在高亮代碼上,Eclipse會給出提示警告信息。

對於Checkstyle檢查選項的詳細配置,我們可以在Eclipse中進行配置修改,如下圖,選中chenzhou_checkstyle

點擊右邊的Configure按鈕,彈出下面的界面

上圖中,左邊的菜單項代表我們可以進行配置的選項,每一個菜單項都可以展開爲多個子菜單項。我們可以分別進行配置。其中菜單項上標了綠色對勾的表示該項以及所有子項已經添加到了檢查項中。如果子項沒有全部添加,則父菜單項不會顯示綠色對勾。

 

如果我們需要添加某個配置項,可以點擊選中某個菜單項,然後點擊下方的Add按鈕,選擇OK後該項的子菜單項會顯示在右邊區域,我們可以通過勾選菜單項前的複選框對具體的項進行配置。如下圖所示

對於具體的每一項的意思,就不一一細說了,應該大家應該都能看懂!

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章