CheckStyle將能夠為你帶來在eclipse中所能夠使用的樣式插件，讓你能夠更好地進行各項編程操作，為你提供各類樣式的制作帶來最佳的編程效果，輕松實現(xiàn)所需的各類編程功能！

官方介紹

是SourceForge下的一個項目，提供了一個幫助JAVA開發(fā)人員遵守某些編碼規(guī)范的工具。它能夠自動化代碼規(guī)范檢查過程，從而使得開發(fā)人員從這項重要，但是枯燥的任務中解脫出來。

安裝方法：

下載成功后，將文件解壓，會有兩個文件夾features和plugins，將兩文件夾下的內(nèi)容分別復制到myeclipse 6.0\eclipse下面的features和plugins兩個文件夾下，重新啟動myeclipse，在window-->preferences下面可以看到Checkstyle

方法一：

1.Eclipse中，選擇Help->Software Updates->Find and Install

2.選擇 Search for new features to install 選擇Next

3.選擇 New Remote Site

4.輸入更新地址

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

5. 安裝后重啟即可

方法二：

1.下載eclipse插件

下載后，把里面的兩個文件夾plugins和 features下面的文件分別拷貝到eclipse目錄下面對應的plugins和features目錄

2.如果你就這樣直接啟動eclipse 可能會出現(xiàn)ClassNotFoundExceptions 等錯誤，所以必須在啟動eclipse的時候加上一個參數(shù) -clean. 這樣eclipse就可以更新它當前安裝的許多插件信息

比如你得eclipse在d盤 那么就是 d:\eclipse\eclipse.exe -clean 

checkStyle 使用

選中工程，右鍵選擇checkstyle->check code with checkstyle,檢查錯誤即可

Checkstyle的結果輸出

序號      輸出內(nèi)容意義

1 Type is missing a javadoc commenTCLass  缺少類型說明

2“{” should be on the previous line “{” 應該位于前一行

3Methos is missing a javadoc comment方法前面缺少javadoc注釋

4Expected @throws tag for “Exception”在注釋中希望有@throws的說明

5“.” Is preceeded with whitespace “.” 前面不能有空格

6“.” Is followed by whitespace“.” 后面不能有空格

7“=” is not preceeded with whitespace“=” 前面缺少空格

8“=” is not followed with whitespace“=” 后面缺少空格

9“}” should be on the same line“}” 應該與下條語句位于同一行

10Unused @param tag for “unused”沒有參數(shù)“unused”，不需注釋

11Variable “CA” missing javadoc變量“CA”缺少javadoc注釋

12Line longer than 80characters行長度超過80

13Line contains a tab character行含有”tab” 字符

14Redundant “Public” modifier冗余的“public” modifier

15Final modifier out of order with the JSL suggestionFinal modifier的順序錯誤

16Avoid using the “.*” form of importImport格式避免使用“.*”

17Redundant import from the same package從同一個包中Import內(nèi)容

18Unused import-java.util.listImport進來的java.util.list沒有被使用

19Duplicate import to line 13重復Import同一個內(nèi)容

20Import from illegal package從非法包中 Import內(nèi)容

21“while” construct must use “{}”“while” 語句缺少“{}”

22Variable “stest1” must be private and have accessor method變量“sTest1”應該是private的，并且有調(diào)用它的方法

23Variable “ABC” must match pattern “^[a-z][a-zA-Z0-9]*$”變量“ABC”不符合命名規(guī)則“^[a-z][a-zA-Z0-9]*$”

24“(” is followed by whitespace“(” 后面不能有空格 25“)” is proceeded by whitespace“)” 前面不能有空格

常見提示解釋：

1Type is missing a javadoc commentClass 缺少類型說明

2“{” should be on the previous line“{” 應該位于前一行。解決方法：把“{”放到上一行去

3Methos is missing a javadoc comment 方法前面缺少javadoc注釋。解決方法：添加javadoc注釋 類似這樣：

/**

* set default mock parameter.（方法說明）

* @param additionalParameters parameter additional(參數(shù)名稱)

* @return data manager(返回值說明)

* @throws Exception if has error(異常說明)

*/

4 Expected @throws tag for “Exception”在注釋中希望有@throws的說明

解決方法：在方法前得注釋中添加這樣一行：* @throws Exception if has error(異常說明)

5“.” Is preceeded with whitespace “.” 前面不能有空格。解決方法：把“（”前面的空格去掉

6“.” Is followed by whitespace“.” 后面不能有空格。解決方法：把“）”后面的空格去掉

7“=” is not preceeded with whitespace“=” 前面缺少空格。解決方法：在“=”前面加個空格

8“=” is not followed with whitespace“=” 后面缺少空格。解決方法：在“=”后面加個空格

9“}” should be on the same line“}” 應該與下條語句位于同一行。解決方法：把“}”放到下一行的前面

10Unused @param tag for “unused”沒有參數(shù)“unused”，不需注釋

解決方法：“* @param unused parameter additional(參數(shù)名稱)” 把這行unused參數(shù)的注釋去掉“

11 Variable “CA” missing javadoc變量“CA”缺少javadoc注釋

解決方法：在“CA“變量前添加javadoc注釋：/** CA. */（注意：一定記得加上“.”）

12 Line longer than 80characters行長度超過80  。解決方法：把它分成多行寫。必要時候，可以ctrl+shift+f

13 Line contains a tab character行含有”tab” 字符?？焖俳鉀Q方法：可以使用EditPlus中的format功能，把tab字符轉(zhuǎn)化為空格，然后保存EditPlus英文版安裝文件在我機子上有。需要的可以來拷貝。注冊Editplus，點擊安裝文件中注冊的文件

14 Redundant “Public” modifier冗余的“public” modifier   。解決方法：冗余的“public”

15 Final modifier out of order with the JSL suggestion Final modifier的順序錯誤

16 Avoid using the “.*” form of importImport格式避免使用“.*”

17 Redundant import from the same package從同一個包中Import內(nèi)容

18 Unused import-java.util.listImport進來的java.util.list沒有被使用。解決方法：去掉導入的多余的類

19 Duplicate import to line 13重復Import同一個內(nèi)容    解決方法：去掉導入的多余的類

20 Import from illegal package從非法包中 Import內(nèi)容

21 “while” construct must use “{}”  “while” 語句缺少“{}”

22 Variable “sTest1” must be private and have accessor method變量“sTest1”應該是private的，并且有調(diào)用它的方法

23 Variable “ABC” must match pattern “^[a-z][a-zA-Z0-9]*$”變量“ABC”不符合命名規(guī)則“^[a-z][a-zA-Z0-9]*$”解決方法：把這個命名改成符合規(guī)則的命名 “aBC”

24 “(” is followed by whitespace“(” 后面不能有空格 25“)”is proceeded by whitespace“)” 前面不能有空格

解決方法：把前面或者后面的空格去掉

25 First sentence should end with a period.解決方法：你的注釋的第一行文字結束應該加上一個"."。

26 Redundant throws: 'NameNotFoundException' is subclass of 'NamingException'. 'NameNotFoundException '是'NamingException'的子類重復拋出異常。

解決方法：如果拋出兩個異常，一個異常類是另一個的子類，那么只需要寫父類

去掉NameNotFoundException異常，對應的javadoc注釋異常注釋說明也需要去掉

27 Parameter docType should be final. 參數(shù)docType應該為final類型  解決方法：在參數(shù)docType前面加個final

28 Line has trailing spaces. 多余的空行  解決方法：去掉這行空行

29 Must have at least one statement.  至少一個聲明

解決方法：} catch (NumberFormatException nfe) {

LOG.error("Auto Renews the agreement failed", nfe);//異常捕捉里面不能為空，在異常里面加一句話。如打印等等

30 '>' is not followed by whitespace.并且又有 '(' is preceded with whitespace.

定義集合和枚舉的時候的時候，最后一個“>”后面要有空格，“（”前面不容許有空格。解決方法：去掉泛型

31 Got an exception - java.lang.RuntimeException: Unable to get class information for @throws tag 'SystemException'.原因：不合理的throws。

解決方法：要確保某些類型，如某些類、接口不被throws。把聲明的異常去掉。在實現(xiàn)類中拋出異常

網(wǎng)上參考解決方法：1、這是CheckStyle報的錯。通常需要Refreh, clean/build這個project. 如果不行，可以嘗試clean all projects, restart Eclipse.

2、因為編譯好的類沒有在checkstyle的classpath中.所以, 只要將編譯好的class配置到在<checkstyle/>的classpath中就沒有這個問題了.另外, 還發(fā)現(xiàn)checkstyle的line length好像也有點問題, 明明沒有超過120個字符, 卻還是報錯.無奈, 我把Eclipse中java > code style > formatter中的Maximum line with改成了100, 然后format一下, 基本就沒有問題了

32 File does not end with a newline.解決方法：刪掉報錯的類，新建一個同名的類，把代碼全部復制過去

33 Utility classes should not have a public or default constructor. 接口中的內(nèi)部類中不應該有公共的或者默認的構造方法

解決方法：在內(nèi)部類中，定義一個私有的構造方法，然后內(nèi)部類聲明為final類型。如果前面有static，那么final還必須放在static之后

34 Variable 'functionCode' must be private and have accessor methods.變量要改成private然后提供訪問的方法

解決方法：給這些變量的修飾符改成private，然后提供set，get方法，并加上對應的方法javadoc注釋、參數(shù)注釋。并在返回值和參數(shù)類型前添加final。并把調(diào)用了這個變量的地方改成通過方法訪問

35   'X' hides a field.

public class Foo

{

    private int bar;

    public Foo(int bar)

    {

        this.bar = bar;

    }

    public final int getBar()

    {

        return bar;

    }

}

全局private int bar;和局部public Foo(int bar)的bar變量名字重復。

解決方法：把方法里面的參數(shù)名稱改變下就可以了public Foo(int newBar)

    {

        this.bar = newBar;

    }。

36 Got an exception - Unexpected character 0xfffd in identifier

這是因為CheckStyle不能識別制定的編碼格式。

網(wǎng)上參考解決方法：

1、Eclipse中可以配置，在Other-->checker中可以指定

2、可以修改checkstyle配置文件：

<module name="Checker">

<property name="severity" value="warning"/>

<property name="charset" value="UTF-8"/>

<module name="TreeWalker">

如果是UTF-8的話，就添加加粗斜體的那條語句，就可以了。

37  Got an exception - java.lang.RuntimeException: Unable to get class information for @throws tag *whatever*.

網(wǎng)上參考解決方法：選中CheckSytle的JavaDoc --> Method JavaDoc --> logLoadErrors。如果是CheckStyle自己加載時出錯的，打個Log就可以了，不要整出Errors嚇人。

還有一處也可能包出同樣的錯誤。Coding Problems --> Redundant Throws --> logLoadErrors選中即可

38 Expected @param tag for 'dataManager'. 缺少dataManager參數(shù)的注釋   解決方法：在注釋中添加@param dataManager DataManager

網(wǎng)上一些其他錯誤的解答：

1. Parameter X should be final.

public class Foo

{

    private int bar;

    public Foo(int bar)

    {

        this.bar = bar;

    }

    public final int getBar()

    {

        return bar;

    }

}

解釋：public Foo(int bar)的局部變量，被認為是不可改變的，檢查需要加上final關鍵字定義public Foo(final int bar)此錯誤，可以忽略不檢查。

2. Redundant 'X' modifier.

public interface CacheHRTreeService extends Manager {

/**

  * Organization Tree

  * @param orgDto

  * @return

  * @throws Exception

  */

public void setOrganization(OrganizationDTO orgDto) throws Exception;

/**

  * Organization Tree

  * @return

  * @throws Exception

  */

public OrganizationDTO getOrganization() throws Exception;

......

}

解釋：多余的字段。public OrganizationDTO getOrganization() throws Exception;此時public為多余的字段，因為interface定義的時候，就是public的。

需要檢查。

3. - Class X should be declared as final.

解釋：對于單例設計模式，要求返回唯一的類對象。但是HRFactory和ContextFactory為優(yōu)化的兩個類，不需求檢查。

其他的單例類，依然需要進行檢查。

4. - Method 'addChildrenId' is not designed for extension - needs to be

  abstract, final or empty.

解釋：通過父類繼承的，此類有點特殊可以忽略此類。

5. Variable 'id' must be private and have accessor methods.解釋：BaseHRDTO類，為父類，屬性給子類繼承，比較特殊。但是其他的類，聲名需要加上范圍'private'關鍵字。需要檢查。

6. -Array brackets at illegal position.解釋：代碼寫法，習慣不一樣。需要檢查，僅僅提示