Checkstyle の阻害

Java のソースコード静的解析ツール「Checkstyle」。

導入しているチームは結構多いと思う。僕が思う Checkstyle を使用する阻害のひとつが、以下の警告。

「最初の一文はピリオドで終わらなければなりません。」

そのせいで、日本語のドキュメントにもかかわらず句点の代わりにピリオドが使用されている Javadoc を非常によく見かける。

Javadoc のドキュメントには、以下のように記載されている。

この「最初の文」は、直後 にスペース、タブ、または改行が続く最初のピリオド (ロケールが英語に設定されている場合)、または最初のブ ロックタグがある位置で終わります。

http://java.sun.com/j2se/1.5.0/ja/docs/ja/tooldocs/windows/javadoc.html

要するに、日本語で Javadoc を書く場合、javadoc コマンドを実行する環境が日本語ロケールであれば、ピリオドなどを使用せずとも句点（。）で十分である。もちろん、いわゆる全角ピリオド（．）でも問題ない。