checkstyle插件（jiàn）下載（zǎi）-checkstyle eclipse plugin下載v8.12 官方版-綠色資（zī）源網

軟件介（jiè）紹

CheckStyle將能（néng）夠為你帶（dài）來在eclipse中所能夠使用的樣式插件，讓你能夠（gòu）更好地進行各項編程操作，為你（nǐ）提供各類樣式的製作帶來最佳的編程效果，輕鬆實現所需（xū）的各類編程功能！

官方介紹

是SourceForge下的一個項目，提供了一個幫助JAVA開發人員（yuán）遵守某些編碼規範的工具。它能夠自動化代（dài）碼規範檢查過程，從而使得（dé）開發人員從這項重要，但是枯燥的任務中解（jiě）脫出來。

安裝方法：

下載成功後（hòu），將文件解壓，會有兩個文件夾features和plugins，將兩（liǎng）文件夾下的（de）內容分別複製到myeclipse 6.0\eclipse下麵的features和plugins兩個文件夾下，重新啟動myeclipse，在window-->preferences下（xià）麵可以看到Checkstyle

方法一：

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

2.選擇（zé） Search for new features to install 選（xuǎn）擇Next

3.選擇 New Remote Site

4.輸入更新地址

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

5. 安裝（zhuāng）後重（chóng）啟即可（kě）

方法二（èr）：

1.下載eclipse插件

下載後，把裏麵的兩個文件夾plugins和 features下麵的文件分別拷貝到eclipse目錄下麵對應的plugins和features目錄

2.如果你（nǐ）就這樣直（zhí）接（jiē）啟動eclipse 可能會出現ClassNotFoundExceptions 等錯誤，所以（yǐ）必須（xū）在啟動eclipse的時候加上一個（gè）參數 -clean. 這樣eclipse就可以（yǐ）更新它當前安（ān）裝的許多插件信息

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

checkStyle 使用

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

Checkstyle的結果輸出

序號輸出內容（róng）意義

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

2“{” should be on the previous line “{” 應該位於前（qián）一（yī）行（háng）

3Methos is missing a javadoc comment方法（fǎ）前麵缺少javadoc注釋（shì）

4Expected @throws tag for “Exception”在注釋中希望（wàng）有@throws的說明

5“.” Is preceeded with whitespace “.” 前麵不能有（yǒu）空（kōng）格

6“.” Is followed by whitespace“.” 後麵不能有空格

7“=” is not preceeded with whitespace“=” 前麵（miàn）缺少（shǎo）空格

8“=” is not followed with whitespace“=” 後麵缺少空格

9“}” should be on the same line“}” 應該（gāi）與下條語句位於同一行

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

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

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

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

14Redundant “Public” modifier冗（rǒng）餘的“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è）包（bāo）中Import內容

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

19Duplicate import to line 13重複Import同一個內容

20Import from illegal package從非法包中 Import內容

21“while” construct must use “{}”“while” 語句缺少（shǎo）“{}”

22Variable “stest1” must be private and have accessor method變量“sTest1”應（yīng）該是private的，並且有調用它的方法

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

24“(” is followed by whitespace“(” 後麵不（bú）能有空格 25“)” is proceeded by whitespace“)” 前麵不能有空格

常見提示解釋（shì）：

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

2“{” should be on the previous line“{” 應該位（wèi）於前一行。解決方法：把“{”放到上一行去

3Methos is missing a javadoc comment 方法前麵缺少javadoc注釋。解決方法：添（tiān）加javadoc注釋類似這樣：

/**

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

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

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

* @throws Exception if has error(異常（cháng）說明)

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

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

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

6“.” Is followed by whitespace“.” 後（hòu）麵不能有空格。解決方法：把“）”後（hòu）麵的空格去（qù）掉

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

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

9“}” should be on the same line“}” 應該（gāi）與下條語句位（wèi）於同一行。解決方法：把“}”放到下一行的前麵

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

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

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

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

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

13 Line contains a tab character行含有”tab” 字符。快速解決方（fāng）法：可以（yǐ）使用EditPlus中的format功能，把tab字符轉化為空格，然後保存EditPlus英文版安裝文件在我機子上有。需（xū）要的可以來拷貝。注冊（cè）Editplus，點擊（jī）安裝文件中注冊的文件

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內容

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

19 Duplicate import to line 13重複Import同一個內容解決方法：去掉導入的多餘（yú）的類

20 Import from illegal package從非（fēi）法包（bāo）中 Import內容

21 “while” construct must use “{}” “while” 語句缺（quē）少“{}”

22 Variable “sTest1” must be private and have accessor method變量“sTest1”應該是private的，並且有調用它的方（fāng）法

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

24 “(” is followed by whitespace“(” 後麵不能有（yǒu）空格 25“)”is proceeded by whitespace“)” 前麵不能有空格（gé）

解決方法：把（bǎ）前麵或者後麵的空格去掉

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

26 Redundant throws: 'NameNotFoundException' is subclass of 'NamingException'. 'NameNotFoundException '是'NamingException'的子類重（chóng）複（fù）拋出異常。

解決方法：如果拋出兩個（gè）異常，一個異常類是另一個的子類，那麽隻需要寫父類（lèi）

去（qù）掉NameNotFoundException異常，對應的javadoc注釋（shì）異常注釋說明也需要去（qù）掉

27 Parameter docType should be final. 參數（shù）docType應（yīng）該為final類型解決方法：在參數docType前麵加（jiā）個final

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

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

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

LOG.error("Auto Renews the agreement failed", nfe);//異常捕捉裏麵不能為空，在異常裏麵加（jiā）一句話。如打印等等（děng）

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

定義集合和枚舉的時候的時候，最後一個“>”後麵（miàn）要有空格，“（”前（qián）麵（miàn）不容許有空格（gé）。解決（jué）方法：去掉泛型

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

解（jiě）決方法：要確保某些類型，如某些類、接口不被throws。把聲明的異常去（qù）掉。在實現類中拋出異常

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

2、因為編譯好的類沒有在checkstyle的classpath中.所以, 隻要將編譯（yì）好的（de）class配置到在<checkstyle/>的classpath中就沒（méi）有這個問題了.另外, 還發現（xiàn）checkstyle的line length好像也有點問題, 明（míng）明沒有超（chāo）過120個字符, 卻還是報錯.無奈, 我把Eclipse中java > code style > formatter中的（de）Maximum line with改成了100, 然後（hòu）format一下, 基本就沒有問題了

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

33 Utility classes should not have a public or default constructor. 接口中的內部類中不應該有公共的或者默認的構造（zào）方法

解決方法：在內部類中（zhōng），定義一個私有的構造方法，然（rán）後內部類聲明為final類型。如果前麵（miàn）有static，那麽（me）final還（hái）必須放在static之後

34 Variable 'functionCode' must be private and have accessor methods.變量要改成private然（rán）後提供訪問的方法

解決方法：給這些變（biàn）量的修飾符改（gǎi）成private，然後提供set，get方法，並（bìng）加上對應的方法（fǎ）javadoc注釋、參數（shù）注釋。並在（zài）返回值和參數類型前添加final。並把調用了這個變量的地方改成通過方法訪問

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āng）法裏麵的參數（shù）名稱改變下就可以（yǐ）了public Foo(int newBar)

{

this.bar = newBar;

}。

36 Got an exception - Unexpected character 0xfffd in identifier

這（zhè）是因（yīn）為（wéi）CheckStyle不（bú）能識別（bié）製定的編碼格式。

網上參考解決方（fāng）法：

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

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

如果是UTF-8的話，就（jiù）添加加（jiā）粗斜體的那條語句（jù），就可以了（le）。

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

網上（shàng）參考（kǎo）解決方法：選中（zhōng）CheckSytle的JavaDoc --> Method JavaDoc --> logLoadErrors。如果是CheckStyle自（zì）己加載時出錯的，打個Log就可以了，不（bú）要整出（chū）Errors嚇（xià）人（rén）。

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

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