玩轉Eclipse — 自動代碼規範檢查工具Checkstyle

http://blog.csdn.net/jmyue/article/details/11110857

 

大項目都須要小組中的多人共同完成，可是每一個人都有本身的編碼習慣，甚至不少都是不正確的。那麼如何使小組全部開發人員都遵循某些編碼規範，以保證項目代碼風格的一致性呢？若是硬性地要求每一個開發人員在提交代碼以前，都要對照的編碼規範將本身的代碼檢查一遍，將是一個很是枯燥並且耗時的任務。Checkstyle是一個開源代碼分析工具，可以幫助開發人員保證他們的代碼遵循必定的代碼規範。Checkstyle經過不斷地檢查你的代碼，一旦發現有違反定義的代碼規範的地方就立馬提示，以便開發人員可以及時發現和修改不規範代碼。Checkstyle在Eclipse中的插件是eclipse-cs。

1. 安裝Checkstyle插件

        Eclipse菜單欄上選擇 Help -> Install New Software...，進入以下安裝界面：

        點擊「Add...」打開Add Repository對話框，如圖輸入Name和Location，點擊「OK」。
        選擇剛剛添加的JAutodoc，一直點擊「Next >」直到安裝結束。

2. 配置Checkstyle

        Eclipse菜單欄上選擇 Window -> Preferences -> Checkstyle，進入以下設置界面：

        在Global Check Configurations框中，列出能夠選擇的檢查配置（Check Configuration），Default欄標記爲對勾的默認配置。

        若是想本身配置檢查選擇，能夠點擊「New...」按鈕新建一個配置，進入以下Check Configuration界面：

        檢查配置的類型，能夠有多種選擇。Internal Configuration類型是檢查配置存在於Eclipse內部；External Configuration類型至關於導入一個已有的xml配置文件。Checkstyle配置都是xml文件。

        若是想修改已有的配置，能夠點擊「Configure...」按鈕，打開Checkstyle Configuration對話框，根據須要進行修改。

3. 使用Checkstyle

        Checkstyle會在代碼開發過程當中，不斷地檢查代碼規範，通常檢查的內容包括：

• Javadoc註釋
• 命名約定
• 標題
• Import
• 大小
• 空白
• 修飾符
• 代碼
• 類設計

        下面這段代碼通過Checkstyle檢查以後，不符合規範的代碼，底色都會被標記爲淺黃色進行提示。點擊行頭的提示標記，就會顯示具體不符合規範的地方。示例以下圖所示：

 

 

Reference

        Checkstyle官網

        Checkstyle的Eclipse插件官網