Checkstyle
| 當前版本 |
|
|---|---|
| 源代碼庫 | |
| 編程語言 | Java |
| 操作系統 | 跨平台 |
| 類型 | 靜態代碼分析 |
| 許可協議 | GNU寬通用公共許可證 |
| 網站 | http://checkstyle.sourceforge.net |
Checkstyle[2]是在軟件開發中的一種靜態代碼分析工具，用來檢查Java源代碼是否符合編碼規則。
模塊
Checkstyle定義了一組可用的模塊，每個模塊都提供可配置嚴格程度的規則（強制性的、可選的等）。每項規則都可以發出通知、警告和錯誤。例如，Checkstyle可以檢查下列問題：
- 類、屬性和方法的Javadoc；
- 屬性和方法的命名規範；
- 函數參數數量、代碼行的長度的限制；
- 標題是否存在[3]；
- 包的導入、類、訪問控制修飾符、代碼塊的使用；
- 字符間的間隔；
- 重複代碼[4]；
- 代碼中多種複雜度的度量
用法
Checkstyle構建成一個JAR文件中，繼可以運行在Java虛擬機上，又可以作為一個Apache Ant任務。它還可以集成到集成開發環境或其他工具中。
Checkstyle插件還可以提供其他功能，例如:
- 重載代碼編輯器的語法高亮；
- 在項目瀏覽器里突出顯示存在問題的代碼項；
- 在輸出窗口中添加警告和錯誤輸出
這樣一來，開發者可以直接訪問被Checkstyle高亮的代碼部分。
歷史
Checkstyle最初由Oliver Burn於2001年開始開發，由來自世界各地的幾個開發者組成的開發團隊維護。
版本5.6是目前的穩定版本，其針對的是Java 7。
參見
- 靜態代碼分析工具列表
- EclipseCS（頁面存檔備份，存於網際網路檔案館） - Checkstyle的Eclipse插件
參考文獻
- ^ Release 10.17.0. 2024年5月26日 [2024年6月20日].
- ^ Checkstyle Home Page. 2010 [2010-11-02]. （原始內容存檔於2011-03-17）.
- ^ Header. [2014-06-11]. （原始內容存檔於2014-10-04）.
- ^ Checkstyle Duplicate Code Check. 2010 [2010-11-02]. （原始內容存檔於2010-12-08）.