聞こえないJavaエンジニアが適当に書き連ねていく

つらつらとメモしたり日頃の溜まっている想いを吐き出す場所です。

Eclipse + checkStyle の設定メモ

前提

ベースにするのはGooglecheckStyle設定。

いつかリンクが切れる可能性はあるけど直リンクも貼っておく。 checkstyle/google_checks.xml at master · checkstyle/checkstyle

困ること

日本人なので、JavaDocのコメントは「。」終わりにしたいのに、「.」で終わらないとダメだよと怒られる。

エラーメッセージ:Javadocの最初の文に末尾のピリオドがありません。

対処方法

注意:checkStyle バージョン8.43の時の対処法なので、バージョンアップで設定方法が変わる可能性はある。

SummaryJavadocのプロパティ、periodを定義する。

<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>

参考

SummaryJavadocCheck (checkstyle 8.43 API)