玩轉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外掛程式官網