現已釋出!閱讀關於 11 月新增功能和修復的內容。

Java 格式化和程式碼檢查

由 Red Hat 提供的 Java™ 語言支援 (Language Support for Java™ by Red Hat) 也提供了格式化設定。您可以匯出 Eclipse 格式化檔案,然後在 VS Code 中為您的專案使用它。

此外,還有Checkstyle for JavaSonarLint擴充套件,它們提供了即時程式碼檢查和程式碼分析功能。

格式化程式

您可以使用 Format Document 命令來格式化 Java 檔案。如果您之前沒有指定格式化配置檔案,Java 檔案將使用預設設定進行格式化。

應用格式化設定

您可以輕鬆地從 Eclipse 方案中現有的格式化配置檔案應用格式化設定。例如,如果您想為您的 Java 專案應用Google 風格,那麼您可以在 settings.json 中設定以下屬性:

"java.format.settings.url": "https://raw.githubusercontent.com/google/styleguide/gh-pages/eclipse-java-google-style.xml",

該屬性可以設定為 URL 或本地檔案路徑。如果格式化 XML 檔案包含多個配置檔案,您可以指定配置檔名稱。

"java.format.settings.profile": "GoogleStyle",

設定格式化配置檔案後,Format Document 命令將使用該特定配置檔案來格式化您的 Java 檔案。

編輯格式化設定

Java 擴充套件包 (Extension Pack for Java) 提供了一個編輯器,幫助使用者編輯現有的格式化配置檔案。您可以使用命令 Java: Open Java Formatter Settings with Preview 開啟編輯器。在編輯器中,您可以更改格式化設定並預覽效果。儲存當前編輯器後,更改將儲存到格式化配置檔案中。

注意:格式化設定編輯器僅支援本地格式化配置檔案。如果您的工作區包含遠端格式化配置檔案,它會引導您將其下載到 .vscode 資料夾中。

在編輯器中編輯設定時,您可以在右側的 Preview 面板中預覽更改效果。

您也可以撤銷和重做更改。

SonarLint

SonarLint 是一個易於使用的擴充套件,可幫助您在編碼時查詢和修復錯誤及安全問題。該擴充套件在後臺執行,就像拼寫檢查器一樣,突出顯示可能存在質量或安全問題的原始碼。該擴充套件不僅會告訴您問題是什麼,還會提供上下文指南,說明其危害以及如何修復,並附帶示例。該擴充套件支援超過 500 多個 Java 規則,幷包含一些 快速修復 以自動修復某些質量問題。

即時程式碼分析

問題會直接在編輯器中突出顯示,並帶有懸停提示以提供詳細解釋。

開啟檔案中的問題也可以透過 VS Code 的 Problems 面板進行檢視。在適用時,會提及次要程式碼位置,以便您瞭解問題的來源(例如,導致錯誤的執行路徑)。

規則文件和修復指南

對於檢測到的任何問題,SonarLint 都提供有關違反規則的完整文件,以及它所關聯的最佳編碼實踐。這使您能夠理解問題為何出現以及如何修復。

啟用更多質量和安全規則

預設情況下,SonarLint 提供各種規則來檢測錯誤和漏洞。可以透過 SonarLint Rules 檢視啟用更多檢查。

有關 SonarLint for VS Code 擴充套件 的更多詳細資訊,請訪問 SonarLint 網站

Checkstyle

使用 Checkstyle for Java 擴充套件,您可以使用現有的 checkstyle 配置(Google 或 Sun 的 Check)或您自己的自定義檔案來處理您的專案。在編輯 Java 檔案時,該擴充套件會檢查檔案格式,並在可能的情況下提供即時快速修復。

使用 Checkstyle: Set the Checkstyle Configuration File 命令設定 Checkstyle 配置檔案,並從下拉列表中選擇 Checkstyle 檔案。

Checkstyle for Java (Checkstyle for Java) 擴充套件支援即時程式碼檢查。

以及批次檢查。

當您單擊狀態列中的 Checkstyle 狀態圖示時,將開啟 Problems 面板。

設定 Checkstyle 配置檔案

要設定配置檔案,請右鍵單擊 .xml 檔案,然後選擇 Set the Checkstyle Configuration File

Set Checkstyle configuration file

您還可以透過觸發命令 Checkstyle: Set Checkstyle Configuration File 來在檔案資源管理器中選擇配置檔案。該擴充套件會在您的工作區中查詢 checkstyle.xml 檔案,以便更輕鬆地進行 Checkstyle 配置。您還將看到內建的兩個配置:

  • Google's Check
  • Sun's Check

命令 Checkstyle: Set the Checkstyle Configuration 會檢測潛在的 Checkstyle 配置檔案並列出它們。您也可以直接在輸入框中輸入 URL 來提供配置檔案。

您也可以使用命令 Checkstyle: Set the Checkstyle Version 來設定 Checkstyle 版本。

該命令將

  • 列出主倉庫中的最新 Checkstyle 版本。
  • 列出所有已下載的版本。
  • 列出所有支援的版本。
  • 用複選標記標記當前使用的版本。

此外,您還可以透過配置其路徑來引入任何第三方 Checkstyle 模組。例如,在使用了以下配置後,您可以將 <module name="SingleBreakOrContinueCheck"/><module name="com.github.sevntu.checkstyle.checks.naming.SingleBreakOrContinueCheck"/> 新增到 checkstyle.xml 中來使用這些檢查。

"java.checkstyle.modules": [ "${workspaceFolder}/src/main/resources/sevntu-checks-1.35.0.jar" ]

檢查風格並修復違規項

在編輯 Java 檔案時,該擴充套件會檢查檔案格式,並在可能的情況下提供快速修復。您可以單擊編輯器中的燈泡按鈕來顯示可用的快速修復。

Fix style violation

有關 Checkstyle for Java 的更多詳細資訊,請訪問其 GitHub 倉庫

© . This site is unofficial and not affiliated with Microsoft.