21

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

package pmain;

/**
 * Some text here.
 */

public class Main {

}

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

CheckStyle でこの警告が生成されるのはなぜですか?

使用する必要がある checkstyle 構成が壊れている可能性はありますか? 私は何か間違ったことをしていますか？「Some text here」は最初の文ではありませんか? は "。" ピリオドじゃない？

4

6 に答える 6

22

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

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

パスします。

于 2012-12-29T07:28:58.473 に答える
6

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

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

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

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

参考文献

于 2012-10-29T21:21:27.670 に答える
5

これは私を悩ませました。この追加を削除するには:

...

<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

于 2016-04-27T16:12:03.157 に答える
0

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

/**
 * Let's call this as the first sentence,
 * here the second one.
*/
于 2017-11-11T08:23:02.053 に答える