本ブログはアフィリエイト広告を利用しています。

CheckStyleの”Javadocの最初の文に末尾のピリオドがありません。”を消す

Eclipse + Javaで開発するとよく使用するCheck Styleですが、Eclipseにデフォルトで設定されているものだとあまり好みではなかったので少しだけカスタマイズしました。

カスタマイズ

カスタマイズ前のCheckStyleの定義は https://github.com/checkstyle/checkstyle/blob/master/src/main/resources/google_checks.xml です。
以下のようにperiodプロパティを空文字に設定するとJavadocの末尾がピリオドじゃなくても警告が出なくなります。

    <module name="SummaryJavadoc">
      <property name="forbiddenSummaryFragments"
               value="^@return the *|^This method returns |^A [{]@code [a-zA-Z0-9]+[}]( is a )"/>
      <property name="period" value="" />
    </module>

コメント

タイトルとURLをコピーしました