eclipse的插件checkStyle結(jié)果分析安裝checkStyle插件以及配置 安裝：直接update,，添加更新源地址：http://eclipse-cs./update/,，也可以從http:///projects/eclipse-cs/files/ 下載最新的插件包本地進行安裝。 配置：默認安裝有2個檢查的配置文件,，如下圖,，Type為Build-In的是默認的，可以自己按照內(nèi)置的Copy一個出來后進行修改，或者Import已經(jīng)存在的檢查xml配置文件,。
配合著使用的還有一個Codestyle,，如下圖，設(shè)計到有Clean up,、Template,、Formatter等幾個選項，默認的Eclopse 提供的Clean up好像什么事情都沒做,，所以最好是自己新建一個或者是導入一個。
常見提示解釋 1Type is missing a javadoc commentClass 缺少類型說明 2“{” should be on the previous line“{” 應(yīng)該位于前一行,。解決方法：把“{”放到上一行去 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“}” 應(yīng)該與下條語句位于同一行,。解決方法：把“}”放到下一行的前面 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”應(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]*$”解決方法：把這個命名改成符合規(guī)則的命名 “aBC” 24 “(” is followed by whitespace“(” 后面不能有空格 25“)”is proceeded by whitespace“)” 前面不能有空格 解決方法：把前面或者后面的空格去掉 25 First sentence should end with a period.解決方法：你的注釋的第一行文字結(jié)束應(yīng)該加上一個".",。 26 Redundant throws: 'NameNotFoundException' is subclass of 'NamingException'. 'NameNotFoundException '是'NamingException'的子類重復拋出異常,。 解決方法：如果拋出兩個異常，一個異常類是另一個的子類,，那么只需要寫父類 去掉NameNotFoundException異常,，對應(yīng)的javadoc注釋異常注釋說明也需要去掉 27 Parameter docType should be final. 參數(shù)docType應(yīng)該為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)部類中不應(yīng)該有公共的或者默認的構(gòu)造方法 解決方法：在內(nèi)部類中，定義一個私有的構(gòu)造方法,，然后內(nèi)部類聲明為final類型,。如果前面有static，那么final還必須放在static之后 34 Variable 'functionCode' must be private and have accessor methods.變量要改成private然后提供訪問的方法 解決方法：給這些變量的修飾符改成private,，然后提供set,，get方法，并加上對應(yīng)的方法javadoc注釋,、參數(shù)注釋,。并在返回值和參數(shù)類型前添加final。并把調(diào)用了這個變量的地方改成通過方法訪問 35 'X' hides a field. public class Foo public Foo(int bar) public final int getBar() 全局private int bar;和局部public Foo(int bar)的bar變量名字重復,。 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*. 38 Expected @param tag for 'dataManager'. 缺少dataManager參數(shù)的注釋 解決方法：在注釋中添加@param dataManager DataManager 網(wǎng)上一些其他錯誤的解答： public Foo(int bar) public final int getBar() 解釋：public Foo(int bar)的局部變量，被認為是不可改變的,，檢查需要加上final關(guān)鍵字定義public Foo(final int bar)此錯誤,，可以忽略不檢查,。 2. Redundant 'X' modifier. public interface CacheHRTreeService extends Manager { /** /** 解釋：多余的字段。public OrganizationDTO getOrganization() throws Exception;此時public為多余的字段,，因為interface定義的時候,，就是public的。 需要檢查,。 3. - Class X should be declared as final. 解釋：對于單例設(shè)計模式,，要求返回唯一的類對象。但是HRFactory和ContextFactory為優(yōu)化的兩個類,，不需求檢查,。 4. - Method 'addChildrenId' is not designed for extension - needs to be 解釋：通過父類繼承的,，此類有點特殊可以忽略此類。 5. Variable 'id' must be private and have accessor methods.解釋：BaseHRDTO類,，為父類，屬性給子類繼承,，比較特殊,。但是其他的類，聲名需要加上范圍'private'關(guān)鍵字,。需要檢查,。 6. -Array brackets at illegal position.解釋：代碼寫法，習慣不一樣,。需要檢查,，僅僅提示 |
|
|
