我使用插件對我的代碼進行分析，我這裡使用的checkStyle的插件，還有很多其他的插件，用了一個，其他都差不多,還有一個PMD的插件，
一直重來沒有注重代碼規范，所以這裡我開始注意
第一步：安裝CheckStyle插件
出現如下窗口之後，選擇ADD
之後，Namd的名稱一般都是插件名稱，路徑為下載路徑
直接update，
添加更新源地址：http://eclipse-cs.sf.net/update/，
也可以從http://sourceforge.net/projects/eclipse-cs/files/ 下載最新的插件包本地進行安裝
我使用的在線安裝方式，另外的安裝方式我失敗了！
如果第一個路徑不好使，那麼請使用第二個路徑，出現如下結果，選中全選即可
繼續進行安裝
中間過程出現了以下提示框，點擊OK，繼續啊！
安裝完畢之後，需要重啟STS IDE
驗證是否成功，可以對項目進行實時驗證，但是我一般不太推薦！呵呵！
/************************關於常見的代碼質量修改*************************************/
1.Line contains a tab character行含有"tab" 字符。
快速解決方法：可以使用editplus中的format功能，把tab字符轉化為空格，然後保存Editplus英文版安裝文件在我機子上有。
抱歉我不喜歡這種方式，我還是在我的Eclipse中修改模版方式，下面的截圖來自於網絡:
1.點擊 window->preference-,依次選擇 General->Editors->Text Editors,選中右側的 insert space for tabs;如下圖所示，保存，第一步完成；
2.點擊 window->preference-,依次選擇 java（或C++）->code style ->formatter,點擊右側的editor，選則左側 tab policy的值為spaces only,確定，應用保存即可，如下圖所示：
若出現應用Apply按鈕為灰色的情況，需要回到上一步，點擊new按鈕，根據當前的樣式重新生成一個新的樣式並保存，重復第2步，編輯該樣式即可，如下圖：
但是針對XML,還需要修改tab鍵編程4個空格，修改如下
/**
* 初始化Servlet API
* @param request
* @param response
*/
3.4 checkstyle常見提示速查
Checkstyle常見錯誤和警告提示見下表所示：
錯誤提示
錯誤說明
missing a javadoc comment
缺少類注釋
Line longer than X characters
行長度超過X個字符(包括空格)
Return count is X(max allowed 3)
一個方法內的返回數量是X(最大值只能為3)
Nested if-else depth is X(max allowed is 3)
最大的if-else嵌套層數為X(最大只能為3)
Array brackets at illegal position
數組的方括號"[]"的位置不正確（檢查數組類型的定義是String[] args，而不是String args[]）
Line matchs the illegal pattern 'System\.out\.println'
本行包含System.out.println語句
ctor def modifier at indentation level 8 not at corrent indentation 4
縮進不正確，一般是因為沒有在Eclipse中使用4個空格代替tab鍵引起。
'static' modifier out of order with the JLS suggestions
static修飾符沒有按照JLS的建議來排序(eg.寫成public final static...應該改成public static final)
Name 'X' must match pattern '^[A-Z][A-Z0-9][_A-Z0-9+]$'(正則表達式)
名稱不符合正則表達式'^[A-Z][A-Z0-9][_A-Z0-9+]$'(即為大寫字母，數字、下劃線等)。
一般在靜態變量沒有大寫時提示，包名不是全部消息時提示，類名不是大寫開頭時提示，方法名不是小寫開頭時提示
Variable access definition in wrong order
變量定義順序不正確(例如在類成員變量定義時，將private類型的變量定義在public類型的變量之前)
Static variable definition in wrong order
靜態變量定義順序不正確(例如在構造函數之後定義靜態變量)
Instance variable definition in wrong order
成員變量定義順序不正確(例如在構造函數之後定義成員變量)
X is a magic number
X是一個魔術數字(非0、1、2的數字)
if construct must use '{}'
if結構必須使用'{}'
Got an exception - Unexpected character 0xfffd in identifier
因為沒有設置checkstyle配置文件的charset為UTF-8，而類文件使用UTF-8編碼，並且含有中文
"{" should be on the previous line
"{" 應該位於前一行
Methods is missing a javadoc comment
方法前面缺少javadoc注釋
Expected @throws tag for "Exception"
在注釋中希望有@throws的說明
"." Is preceeded with whitespace
"." 前面不能有空格
"." Is followed by whitespace
"." 後面不能有空格
"=" is not preceeded with whitespace"="
前面缺少空格
"=" is not followed with whitespace
"=" 後面缺少空格
"}" should be on the same line
"}" 應該與下條語句位於同一行
Unused @param tag for "unused"
沒有參數"unused"，不需注釋
Variable "X" missing javadoc
變量"CA"缺少javadoc注釋
Line contains a tab character
行含有"tab" 字符
Redundant "Public" modifier
冗余的"public" modifier
final modifier out of order with the JSL suggestion
final修飾符的順序錯誤
Avoid using the ".*" form of import
Import格式避免使用".*"
Redundant import from the same package
從同一個包中Import內容
Unused import-X Import
import的X類沒有被使用
Duplicate import to line X
重復Import同一個內容
Import from illegal package
從非法包中 Import內容
"while" construct must use "{}"
"while" 語句缺少"{}"
Variable "X" must be private and have accessor method
變量"X"應該是private的，並且有調用它的方法
Variable "X" must match pattern"^[a-z][a-zA-Z0-9]*$"
變量"X"不符合命名規則"^[a-z][a-zA-Z0-9]*$"
"(" is followed by whitespace
"(" 後面不能有空格
")" 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(參數名稱)
* @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"沒有參數"unused"，不需注釋
解決方法："* @param unused parameter additional(參數名稱)" 把這行unused參數的注釋去掉"
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" 字符。快速解決方法：可以使用editplus中的format功能，把tab字符轉化為空格，然後保存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內容
18 Unused import-java.util.listImport進來的java.util.list沒有被使用。解決方法：去掉導入的多余的類
19 Duplicate import to line 13重復Import同一個內容 解決方法：去掉導入的多余的類
20 Import from illegal package從非法包中 Import內容
21 "while" construct must use "{}" "while" 語句缺少"{}"
22 Variable "sTest1" must be private and have accessor method變量"sTest1"應該是private的，並且有調用它的方法
23 Variable "ABC" must match pattern "^[a-z][a-zA-Z0-9]*$"變量"ABC"不符合命名規則"^[a-z][a-zA-Z0-9]*$"解決方法：把這個命名改成符合規則的命名 "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. 參數docType應該為final類型 解決方法：在參數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。把聲明的異常去掉。在實現類中拋出異常
網上參考解決方法：1、這是CheckStyle報的錯。通常需要Refreh, clean/build這個Project. 如果不行，可以嘗試clean all projects, restart Eclipse.
2、因為編譯好的類沒有在checkstyle的classpath中.所以, 只要將編譯好的class配置到在的classpath中就沒有這個問題了.另外, 還發現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. 接口中的內部類中不應該有公共的或者默認的構造方法
解決方法：在內部類中，定義一個私有的構造方法，然後內部類聲明為final類型。如果前面有static，那麼final還必須放在static之後
34 Variable 'functionCode' must be private and have accessor methods.變量要改成private然後提供訪問的方法
解決方法：給這些變量的修飾符改成private，然後提供set，get方法，並加上對應的方法javadoc注釋、參數注釋。並在返回值和參數類型前添加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變量名字重復。
解決方法：把方法裡面的參數名稱改變下就可以了public Foo(int newBar)
{
this.bar = newBar;
}。
36 Got an exception - Unexpected character 0xfffd in identifier
這是因為CheckStyle不能識別制定的編碼格式。
網上參考解決方法：
1、Eclipse中可以配置，在Other-->checker中可以指定
2、可以修改checkstyle配置文件：
如果是UTF-8的話，就添加加粗斜體的那條語句，就可以了。
37 Got an exception - java.lang.RuntimeException: Unable to get class information for @throws tag *whatever*.
網上參考解決方法：選中CheckSytle的JavaDoc --> Method JavaDoc --> logLoadErrors。如果是CheckStyle自己加載時出錯的，打個Log就可以了，不要整出Errors嚇人。
還有一處也可能包出同樣的錯誤。Coding Problems --> Redundant Throws --> logLoadErrors選中即可
38 Expected @param tag for 'dataManager'. 缺少dataManager參數的注釋 解決方法：在注釋中添加@param dataManager DataManager
網上一些其他錯誤的解答：
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為優化的兩個類，不需求檢查。
其他的單例類，依然需要進行檢查。
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.解釋：代碼寫法，習慣不一樣。需要檢查，僅僅提示
