checkstyle eclipse plugin

CheckStyle將能夠?yàn)槟銕?lái)在eclipse中所能夠使用的樣式插件，讓你能夠更好地進(jìn)行各項(xiàng)編程操作，為你提供各類(lèi)樣式的制作帶來(lái)最佳的編程效果，輕松實(shí)現(xiàn)所需的各類(lèi)編程功能！

官方介紹

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

安裝方法：

下載成功后，將文件解壓，會(huì)有兩個(gè)文件夾features和plugins，將兩文件夾下的內(nèi)容分別復(fù)制到myeclipse 6.0\eclipse下面的features和plugins兩個(gè)文件夾下，重新啟動(dòng)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插件

下載后，把里面的兩個(gè)文件夾plugins和 features下面的文件分別拷貝到eclipse目錄下面對(duì)應(yīng)的plugins和features目錄

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

比如你得eclipse在d盤(pán) 那么就是 d:\eclipse\eclipse.exe -clean 

checkStyle 使用

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

Checkstyle的結(jié)果輸出

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

1 Type is missing a javadoc commenTCLass  缺少類(lèi)型說(shuō)明

2“{” should be on the previous line “{” 應(yīng)該位于前一行

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

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

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“}” 應(yīng)該與下條語(yǔ)句位于同一行

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

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

12Line longer than 80characters行長(zhǎng)度超過(guò)80

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

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

15Final modifier out of order with the JSL suggestionFinal modifier的順序錯(cuò)誤

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

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

18Unused import-java.util.listImport進(jìn)來(lái)的java.util.list沒(méi)有被使用

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

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

21“while” construct must use “{}”“while” 語(yǔ)句缺少“{}”

22Variable “stest1” must be private and have accessor method變量“sTest1”應(yīng)該是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“)” 前面不能有空格

常見(jiàn)提示解釋?zhuān)?/h3>

1Type is missing a javadoc commentClass 缺少類(lèi)型說(shuō)明

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

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

/**

* set default mock parameter.（方法說(shuō)明）

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

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

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

*/

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

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

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

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

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

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

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

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

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

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

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

12 Line longer than 80characters行長(zhǎng)度超過(guò)80  。解決方法：把它分成多行寫(xiě)。必要時(shí)候，可以ctrl+shift+f

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

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

15 Final modifier out of order with the JSL suggestion Final modifier的順序錯(cuò)誤

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

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

18 Unused import-java.util.listImport進(jìn)來(lái)的java.util.list沒(méi)有被使用。解決方法：去掉導(dǎo)入的多余的類(lèi)

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

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

21 “while” construct must use “{}”  “while” 語(yǔ)句缺少“{}”

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

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

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

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

25 First sentence should end with a period.解決方法：你的注釋的第一行文字結(jié)束應(yīng)該加上一個(gè)"."。

26 Redundant throws: 'NameNotFoundException' is subclass of 'NamingException'. 'NameNotFoundException '是'NamingException'的子類(lèi)重復(fù)拋出異常。

解決方法：如果拋出兩個(gè)異常，一個(gè)異常類(lèi)是另一個(gè)的子類(lèi)，那么只需要寫(xiě)父類(lèi)

去掉NameNotFoundException異常，對(duì)應(yīng)的javadoc注釋異常注釋說(shuō)明也需要去掉

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

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

29 Must have at least one statement.  至少一個(gè)聲明

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

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

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

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

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

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

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

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

32 File does not end with a newline.解決方法：刪掉報(bào)錯(cuò)的類(lèi)，新建一個(gè)同名的類(lèi)，把代碼全部復(fù)制過(guò)去

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

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

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

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

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變量名字重復(fù)。

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

    {

        this.bar = newBar;

    }。

36 Got an exception - Unexpected character 0xfffd in identifier

這是因?yàn)镃heckStyle不能識(shí)別制定的編碼格式。

網(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的話，就添加加粗斜體的那條語(yǔ)句，就可以了。

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

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

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

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

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

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;

    }

}

解釋?zhuān)簆ublic Foo(int bar)的局部變量，被認(rèn)為是不可改變的，檢查需要加上final關(guān)鍵字定義public Foo(final int bar)此錯(cuò)誤，可以忽略不檢查。

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;

......

}

解釋?zhuān)憾嘤嗟淖侄?。public OrganizationDTO getOrganization() throws Exception;此時(shí)public為多余的字段，因?yàn)閕nterface定義的時(shí)候，就是public的。

需要檢查。

3. - Class X should be declared as final.

解釋?zhuān)簩?duì)于單例設(shè)計(jì)模式，要求返回唯一的類(lèi)對(duì)象。但是HRFactory和ContextFactory為優(yōu)化的兩個(gè)類(lèi)，不需求檢查。

其他的單例類(lèi)，依然需要進(jìn)行檢查。

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

  abstract, final or empty.

解釋?zhuān)和ㄟ^(guò)父類(lèi)繼承的，此類(lèi)有點(diǎn)特殊可以忽略此類(lèi)。

5. Variable 'id' must be private and have accessor methods.解釋?zhuān)築aseHRDTO類(lèi)，為父類(lèi)，屬性給子類(lèi)繼承，比較特殊。但是其他的類(lèi)，聲名需要加上范圍'private'關(guān)鍵字。需要檢查。

6. -Array brackets at illegal position.解釋?zhuān)捍a寫(xiě)法，習(xí)慣不一樣。需要檢查，僅僅提示