1.?概述

隨著中心的代碼規(guī)范的建立和實施，項目組對代碼規(guī)范要求，以及軟件工程師們對自身代碼的編寫規(guī)范重要性的認知，“代碼規(guī)范”已經(jīng)成為了中心的一個“熱詞”。然后怎么才能寫出有規(guī)范的代碼，怎么才能養(yǎng)成編碼規(guī)范習慣？相信很多人都知道Checkstyle這個編碼規(guī)范工具，本文講述了Checkstyle在eclipse中的安裝過程，以及使用方法。希望通過本文，讓大家能簡單快速的掌握Checkstyle。

2.?認識Checkstyle

CheckStyle是SourceForge下的一個項目，提供了一個幫助JAVA開發(fā)人員遵守某些編碼規(guī)范的工具。它能夠自動化代碼規(guī)范檢查過程，從而使得開發(fā)人員從這項重要但枯燥的任務(wù)中解脫出來。它可以根據(jù)設(shè)置好的編碼規(guī)則來檢查代碼。比如符合規(guī)范的變量命名，方法體的最大行數(shù)，重復代碼檢查等等。

如果你的項目經(jīng)理開會時說：“我希望我們寫出來的代碼就象一個人寫的!”，那么用Checkstyle絕對是正確選擇！

3.?資源說明

Checkstyle：http://sourceforge.net/projects/eclipse-cs/

?

本篇是在eclipse4.2上面安裝最新版的checkstyle插件為例。Eclipse的位置在D:\Program?Files\eclipse，checkstyle下載后在D:\Sdk\checkstyle\net.sf.eclipsecs-updatesite_5.7.0.201402131929-bin.zip，其中使用的checkstyle規(guī)則文件在D:\Sdk\checkstyle\style_template.xml

資源下載地址：

http://download.csdn.net/detail/ccboy2009/7521353

4.?Checkstyle插件安裝

下面講解checkstyle在eclipse上的兩種安裝方式。

??離線安裝

①　下載checkstyle離線安裝包；

http://sourceforge.net/projects/eclipse-cs/

?

?

②　下載完成后將壓縮包中features文件夾和plugins文件夾的復制到eclipse中的根目錄中進行覆蓋；

?

③　打開eclipse，Window-->Preferences,如果列表中出現(xiàn)了checkstyle的菜單，則表示安裝成功了。

?

注意：如果啟動eclipse時，提示ClassNotFoundException等異常信息，則啟動時加上一個“-clean”參數(shù)啟動即可。

?

??在線安裝

注意在安裝過程中保持網(wǎng)絡(luò)暢通，如果網(wǎng)絡(luò)不穩(wěn)定可能會導致安裝失敗。

Help?-->?Install?New?Software

CheckStyle插件地址：http://eclipse-cs.sourceforge.net/update

?

Next-->next-->選擇?I?accept...?Finish。Checkstyle插件就開始安裝。

在安裝過程中，可能會出現(xiàn)警告提示，選擇ok即可。

?

安裝完成后，根據(jù)提示重啟eclipse，checkstyle即安裝完成。

5.?Checkstyle全局配置

Window?-->Preferences,選擇checkstyle菜單，增加項目組統(tǒng)一的規(guī)則文件，并設(shè)置為默認規(guī)則。如下圖：

?

到此全局配置已經(jīng)完成。

6.?Checkstyle項目配置

項目?-->?右鍵Properties

?

到此項目配置已經(jīng)完成。成功的話，checkstyle已經(jīng)開始工作了。

?

此次發(fā)現(xiàn)項目上有很多紅叉叉，說明是代碼符合規(guī)范造成的。

?

根據(jù)提示信息修改后，則沒有有紅色的提示。

?

7.?其它操作

在項目右鍵菜單中，checkstyle還有一些快捷操作，如下圖所示：

8.?結(jié)語

通過本文的閱讀和學習，相信你對Checkstyle這個編碼規(guī)范工具有了一定的認識和熟悉。但要想規(guī)范自己的代碼編寫規(guī)則，項目組要統(tǒng)一組內(nèi)代碼規(guī)范，只依靠這個工具是不行的，需要大家堅持使用這個工具，逐漸的就會形成一種習慣，最終拋棄Checkstyle照樣能寫出規(guī)范的代碼。

?

本文轉(zhuǎn)自：http://blog.csdn.net/ccboy2009/article/details/32318781

轉(zhuǎn)載于:https://www.cnblogs.com/nizuimeiabc1/p/8572583.html

總結(jié)

以上是生活随笔為你收集整理的在eclipse上Checkstyle的安装和使用的全部內(nèi)容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯，歡迎將生活随笔推薦給好友。