検証環境
Checkstyleバージョン：10.3.3
Javaバージョン：17
チェック概要
| チェック追加バージョン |
|---|
| Checkstyle 5.0 |
各Javaパッケージがコメント用に使用されるJavadocファイルを持っているかどうかをチェックする。
デフォルトでは、package-info.java ファイルのみを許可するが、 package.html ファイルを許可するように設定することも可能。
両方のファイルが存在する場合、Javadocツールで許可されていないため、違反となる。
プロパティ
| プロパティ | 型 | デフォルト値 | 説明 | 追加バージョン |
|---|---|---|---|---|
| allowLegacy | boolean | false | package.htmlファイルを使用できるようにするかどうか | 5.0 |
| fileExtensions | String[] |
.java | 処理するファイルのファイルタイプ拡張子を指定する | 5.0 |
設定＋チェック実行結果
プロパティ設定なし
設定ファイル記述方法
<module name="Checker"> <module name="JavadocPackage"/> </module>
チェック実行例
package-info.javaがない場合NG
プロパティ設定あり
設定ファイル記述方法
<module name="Checker"> <module name="JavadocPackage"> <property name="allowLegacy" value="true"/> </module> </module>
チェック実行例
package.htmlがない場合NG
