MissingJavadocPackage

CheckStyle公式ドキュメント

検証環境

Checkstyleバージョン：10.3.3
Javaバージョン：17

---

チェック概要

チェック追加バージョン
Checkstyle 8.22

package-info.javaファイルにJavadocコメントがないかどうかをチェックする。

設定＋チェック実行結果

プロパティ設定なし

設定ファイル記述方法

<module name="Checker">
    <module name="TreeWalker">
        <module name="MissingJavadocPackage"/>
    </module>
</module>

チェック実行例

// OK
/**
* Provides API classes
*/
package com.checkstyle.api;

// NG Javadocコメントがない
/*
* Block comment is not a javadoc
*/
package com.checkstyle.api;