[Checkstyle] パッケージスコープを表すコメントの有無をチェックするCheckstyleプラグインを作りました

Javaでは、メソッドやクラスなどをパッケージスコープとする際にアクセス修飾子を省略します。しかしソースコードの作者以外の人から見ると、アクセス修飾子を省略したのかそれとも書き忘れたのか、判断できません。そこでパッケージスコープであると明示的に示そうと、「/* package */」のようなコメントをアクセス修飾子がない代わりに入れることがあります。例えば、パッケージスコープなメソッドは次のように書きます。

    /* package */ void method() {
        ...
    }

Eclipseの一部やAndroidに標準搭載されているブラウザアプリケーションや設定アプリケーションなどがそのようなコーディングルールで記述されています。

Javaで書かれたソースコードがコーディング規約に従っているかどうかをチェックする際には、Checkstyleがよく使用されます。しかし、本記事の執筆時点の最新バージョンであるCheckstyle 5.5では、パッケージスコープを表すコメントの有無をチェックできません。

そこで今回、パッケージスコープを表すコメントの有無をチェックするCheckstyleプラグインを作ってみました。GitHubで公開しています。ライセンスはCheckstyleと同じLGPLです。Checkstyle 5.5以上に対応しています。

本プラグインでは、アクセス修飾子のないクラスなどの定義にパッケージスコープを表すコメントが書かれていることをチェックし、書かれていなければ警告します。加えて、アクセス修飾子が書かれているにもかかわらず以下のようにパッケージスコープを表すコメントがある場合に警告を行います。

    /* package */ public void method() {
        ...
    }

使い方は次の通りです。まず、Checkstyleの設定ファイルに本プラグインのモジュールを追加します。本プラグインのモジュールは、TreeWalkerモジュールのサブモジュールです。例えば、次のようになります。

  <module name="TreeWalker">
    <module name="CommentedPackageVisibilityCheck" />
  </module>

クラスパスに本プラグインのJARファイルを追加して、Checkstyleを実行してください。

JARファイルは、「commented-package-visibility-check-0.1.zip」をダウンロードして展開すると手に入ります。

CommentedPackageVisibilityCheckモジュールには、以下のプロパティを用意しています。必要に応じて設定してください。

プロパティ名	説明	省略時の値
format	パッケージスコープを表すコメントにマッチする正規表現。	/\* package \*/
requireLatterWhiteSpace	パッケージスコープを表すコメントの直後に、少なくとも1文字以上の空白が必要か。	true