Java Opensources for Web Development Part I：
Chapter 5 檢測程式碼
Lession 19 : Checkstyle

工程師的程式碼風格往往不完全相同，因此，一個團隊合作的情況之下，如果能夠利用相同的程式碼風格，查看其他人的程式也會比較輕鬆。尤其在 Opensources 的開發，來自各方的工程師，最好能夠遵循公用的程式碼風格，才能讓大家更容易檢閱你的程式碼。

checkstyle，就是在軟體開發完畢之後，尤其在 codereview 的過程之中，保有 code conversation 的特性，讓未來接手維護的人，利用 checkstyle 的特性，就是檢查一些程式開發上容易忽略的小細節。主要的檢查有

* 是否有 javadoc 的註解碼
* 命名規則是否合適
* 不用的 class import，或是採用 import *
* 空白
* 確認一些非必要的 System.out, 或 printStackTrace 等等
 

不過利用 checkstyle 的預設檢查模式，可能會出現成千上萬不符合的情況，如果採用 Eclipse 想要使用 checkstyle，建議使用 https://eclipse-cs.sourceforge.net/update/ 進行 plugins 下載，另外還有 https://www.mvmsoft.de/content/plugins/checkclipse/checkclipse.htm ，我沒有特別比較出差異，不過 eclipse-cs 得到 2007 Community Awards, 應該還是比較多人喜愛吧。

安裝後，可以在 Eclipse [Window]->[Preferences] 中對於 Checkstyle 的 check 進行設定。新增一套屬於自己的 checkstyle後進行內容的設定 ( Configure )

{mosimage}

一個一個新增你要的 check，例如 javadoc comments 的 package html 對我來說就不是很必要性，我就不把它放進來。

{mosimage}

例如一些習慣長度的限制，例如 Size Violations 的 LineLength 預設是 80，你可以把他修改成 120。

 {mosimage}

以上各種設定，可以 Export 成為 XML 檔案給予其他工程師。

因此，保有程式碼風格的統一，可以增加程式的可閱讀性，千萬不要因為一時的偷懶造成未來維護的困擾，尤其，是希望程式複雜或是維護期長久的系統開發。因為減少 debug 時間就是減少開發的時間。