Checkstyle[2]是在軟件開發中的一種靜態代碼分析工具,用來檢查Java原始碼是否符合編碼規則

Checkstyle
目前版本
  • 10.18.2(2024年9月29日;穩定版本)[1]
編輯維基數據連結
原始碼庫 編輯維基數據連結
程式語言Java
作業系統跨平台
類型靜態代碼分析
許可協定GNU寬通用公共許可證
網站http://checkstyle.sourceforge.net

模組

Checkstyle定義了一組可用的模組,每個模組都提供可組態嚴格程度的規則(強制性的、可選的等)。每項規則都可以發出通知、警告和錯誤。例如,Checkstyle可以檢查下列問題:

  • 類、屬性和方法的Javadoc
  • 屬性和方法的命名規範;
  • 函數參數數量、代碼行的長度的限制;
  • 標題是否存在[3]
  • 包的匯入、類、訪問控制修飾詞、代碼塊的使用;
  • 字元間的間隔;
  • 重複代碼[4]
  • 代碼中多種複雜度的度量

用法

Checkstyle構建成一個JAR檔案中,繼可以執行在Java虛擬機器上,又可以作為一個Apache Ant任務。它還可以整合到整合式開發環境或其他工具中。

Checkstyle外掛程式還可以提供其他功能,例如:

  • 多載代碼編輯器的語法突顯
  • 在專案瀏覽器里突出顯示存在問題的代碼項;
  • 在輸出窗口中添加警告和錯誤輸出

這樣一來,開發者可以直接訪問被Checkstyle突顯的代碼部分。

歷史

Checkstyle最初由Oliver Burn於2001年開始開發,由來自世界各地的幾個開發者組成的開發團隊維護。

版本5.6是目前的穩定版本,其針對的是Java 7

參見

參考文獻

  1. ^ Release 10.18.2. 2024年9月29日 [2024年10月21日]. 
  2. ^ Checkstyle Home Page. 2010 [2010-11-02]. (原始內容存檔於2011-03-17). 
  3. ^ Header. [2014-06-11]. (原始內容存檔於2014-10-04). 
  4. ^ Checkstyle Duplicate Code Check. 2010 [2010-11-02]. (原始內容存檔於2010-12-08). 

拓展閱讀