. VSCodeでCheckstyleによるJavaコーディングルールの適用 | Java Snippets
VSCodeでCheckstyleによるJavaコーディングルールの適用 | Java Snippets
VSCodeでCheckstyleによるJavaコーディングルールの適用 | Java Snippets

Java Snippets

コピペ用のJava便利コードを紹介していくサイトです。VSCodeでJavaを書いていくのを応援していきます！

VSCodeでCheckstyleによるJavaコーディングルールの適用

  1. Checstyle for Javaのインストール
  2. google_checks.xmlのダウンロードとカスタマイズ
  3. workspace設定を行う
  4. 動作確認

Checstyle for Javaのインストール

拡張機能でCheckstyleで検索して見つかる Checkstyle for Javaをインストール。

google_checks.xmlのダウンロードとカスタマイズ

@@ -251,12 +251,12 @@ value="GenericWhitespace '''' is not preceded with whitespace."/> - - - + + + - +

workspace設定を行う

最後にCheckstyle for Javaがこの設定ファイルを使用するように設定します。

  • checkstyleで検索して、Java > Checkstyle: Configurationに、先程プロジェクト直下に配置したgoogle_checks.xmlを指定。
  • Java > Checkstyle: Versionを適当に最新10.3.1に。

Checkstyleバージョンは、メニューから View > Command Pallete… から、Checkstyle: Set the Checkstyle Versionから設定することもできます。

動作確認

/** * クラスJavaDocコメント. */ public class CheckStyleDemo < /** * メソッドJavadocコメント. */ public static void main(String[] args) < var Aaa = 1; //CHECKSTYLE.SUPPRESS: LocalVariableNameCheck //CHECKSTYLE.OFF: LocalVariableNameCheck var Bbb = 2; //CHECKSTYLE.ON: LocalVariableNameCheck var c = Aaa + Bbb; System.out.println(c); >>

//CHECKSTYLE.SUPPRESS: XXX での設定は1行単位で設定し、XXXで指定した警告を除外しています。ここではLocalVariableNameCheckの警告です。警告名は、VSCodeでProblemsのパネルを見ればわかります。

//CHECKSTYLE.OFF と //CHECKSTYLE.ON は、開始と終了の範囲を指定して抑制しているものです。OFFしたままONで戻すのを忘れると、それ以降チェックされていないことになるので注意。

コメントを残す コメントをキャンセル

最近の投稿

  • VSCodeでTomcatを使ったWebApp開発 (cargo編)
  • VSCodeでJavaフォーマッタの設定
  • VSCodeでCheckstyleによるJavaコーディングルールの適用
  • Mapの初期化を1行で書く
  • 現在時刻 ⇔ ( エポック秒 / UNIX時間 ) ⇔ DateTime
📎📎📎📎📎📎📎📎📎📎