web-dev-qa-db-ja.com

「最初の文はピリオドで終わる必要があります。」

Javaのcheckstyleは私を混乱させ、困惑させます。

package pmain;

/**
 * Some text here.
 */

public class Main {

}

これは文字通り私が持っているすべてのコードです。 Checkstyleは、「最初の文はピリオドで終了する必要があります」と表示します。 「/ **」で。

CheckStyleがこの警告を生成するのはなぜですか？

使用する必要のあるcheckstyle設定が壊れている可能性はありますか？私は何か間違ったことをしていますか？ 「ここにいくつかのテキスト」は最初の文ではありませんか？ 「。」です生理ではありませんか？

javacheckstyle
13
Klaabu

最初の文はドットで終わる必要があります。

/**
 *An abstract class that represents an algorithm.
 *
 * @author zhangtj
 *
 * @version 1.0
*/

合格します。

11
Jimmy Zhang

私のマシンでテストしたばかりで、実際には再現できません。文の最後にドットが付いた警告は表示されません。しかし、それを削除すると（そして、checkstyleを再度実行すると）、ルールが正しくトリガーされ、/**行に警告が表示されます。

コメントの後の空白行は違いを生みません。

ドットが実際にはドットであり、ドットのように「見える」他の文字ではないことを再確認してください。また、ファイルを変更した後で、checkstyleを実際に再実行することを再確認してください。自動的にチェックを実行することはありません。

たぶん誰かがcheckstyleの設定で遊んだ。実際には、このルールを制御する2つのプロパティがあります。trueまたはfalseのいずれかであるcheckFirstSentenceと、正規表現でありピリオドと一致する必要があるendOfSentenceFormatです。しかし、ルールセットがそのプロパティを再定義した場合...;）

さらに読む

6
Andreas_D

これは私を苛立たせました。これを削除するには：

.。

<module name="JavadocStyle">
   <property name="checkFirstSentence" value="false"/>
</module>

.。

また、私にとっては[〜＃〜]完全に[〜＃〜]SummaryJavadocモジュールを削除しました。

このチェックをオフに切り替えるには、checkstyle.xmlで。

参照： http://checkstyle.sourceforge.net/config_javadoc.html#JavadocStyle ＆ http://checkstyle.sourceforge.net/config_javadoc.html#SummaryJavadoc

5
theINtoy

コメントの終了後のスペースまたは「。」が原因でシンが発生する可能性があります。

3
aarathi

この警告を避けるために2行を使用します。例えば：

/**
 * Let's call this as the first sentence,
 * here the second one.
*/
0
EgorTitov