"Первое предложение должно заканчиваться периодом".

Java checkstyle смущает и дезориентирует меня.

package pmain;

/**
 * Some text here.
 */

public class Main {

}

Это буквально весь код, который у меня есть. Checkstyle отображает "Первое предложение должно заканчиваться периодом". на странице "/**".

Почему CheckStyle создает это предупреждение?

Может ли быть изменена конфигурация checkstyle, которую я должен использовать? Я делаю что-то неправильно? Является ли "Некоторый текст здесь" не первым предложением? Является "." не период?

Ответы

Ответ 1

Первое предложение должно заканчиваться точкой.

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

Пройдет.

Ответ 2

Просто протестирован на моей машине и на самом деле не могу воспроизвести: я не получаю предупреждение с точкой в конце предложения. Но как только я удаляю его (и снова запускаю checkstyle), правило запускается правильно, и я получаю предупреждение в строке /**.

Пустая строка после комментария не имеет значения.

Дважды проверьте, что точка - это действительно точка, а не какой-то другой символ, который "выглядит" как точка. И дважды проверьте, что вы действительно повторно запускаете checkstyle после того, как вы изменили файл. Он не будет выполнять проверки автоматически.

Возможно, кто-то играл с настройками checkstyle. На самом деле есть два свойства, которые управляют этим правилом: checkFirstSentence, который является либо истинным, либо ложным, и endOfSentenceFormat, который является регулярным выражением и должен соответствовать периоду. Но если набор правил переопределил это свойство...;)

Дополнительная литература

http://checkstyle.sourceforge.net/config_javadoc.html

Ответ 3

Тонкий может быть вызван пробелом после окончания комментария или '.'

Ответ 4

Это просто раздражало меня. Чтобы удалить это дополнение:

...

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

...

А также для меня я TOTALLY удалил модуль SummaryJavadoc.

в вашем checkstyle.xml, чтобы отключить эту проверку.

См: http://checkstyle.sourceforge.net/config_javadoc.html#JavadocStyle & Амп; http://checkstyle.sourceforge.net/config_javadoc.html#SummaryJavadoc

Ответ 5

Я использую 2 строки, чтобы избежать этого предупреждения. Например:

/**
 * Let call this as the first sentence,
 * here the second one.
*/