在eclipse中使用checkstyle外掛程式自動檢查編碼規範

編碼|規範

 


 



 



 



 



CheckStyle是一個java代碼規範檢查工具。使用CheckStyle能夠強制編程人員遵循某種代碼規範。CheckStyle預設提供了對sun編程規範的支援。通過編寫設定檔，可以增加自己的檢查規範。

CheckStyle的最新版本是3.5。從3.0開始，CheckStyle支援包括代碼風格、代碼結構、代碼冗餘、典型錯誤等更多的代碼檢查。

CheckStyle通常和Ant配合使用。有許多CheckStyle的第三方外掛程式，包括eclipse外掛程式。

CheckStyle的官方網站：http://checkstyle.sourceforge.net/



















CheckStyle預設支援的sun規範見：http://java.sun.com/docs/codeconv/html/CodeConvTOC.doc.html，這個文檔有中文翻譯。

CheckStyle的下載地址：http://sourceforge.net/project/showfiles.php?group_id=29721



















CheckStyle的eclipse外掛程式下載地址：http://prdownloads.sourceforge.net/eclipse-cs/com.atlassw.tools.eclipse.checkstyle_3.3.2.0.zip?download




















 


 



 



 



 



在eclipse環境下安裝CheckStyle外掛程式後，啟動ecslipse，在喜好設定中可以匯入和配置CheckStyle的設定檔。CheckStyle預設安裝了sun的java代碼規範。









       不符合checkstyle檢查標準的資訊“即時”出現在“問題”視圖中。

   





       可以點擊問題視圖的“過濾器”配置顯示內容。

   





















       CheckStyle的檢查規則包含在XML格式的設定檔裡。CheckStyle預設的sun規範檢查檔案是：sun_checks.xml。



















       CheckStyle的設定檔由module組成。Module的結構是樹。樹的root module是Checker。













作者簡介：張昱，可以通過e-zhangyu@vip.sina.com 與作者取得聯絡。