, есть ли способ обработать » но в 1% случаев, когда я действительно намеревался сознательно нарушить правило, я хотел бы сообщить CheckStyle, что ему не нужно заниматься пометкой предупреждения.
Пример: правило комментирования отсутствует в Javadoc. Большую часть времени я хочу, чтобы Javadoc комментировал мои методы. Однако такой метод, как:
public boolean isValid() {
return valid;
}
, вероятно, может обойтись без него.
Есть ли что-то похожее на аннотацию @SuppressWarnings
, которую можно использовать для пометки определенного нарушения правила CheckStyle как допустимого? Может быть, какой-то специально отформатированный комментарий? Я не хочу отключать правило, я просто хочу игнорировать конкретное нарушение.
(я понимаю, что в этом случае я мог бы просто написать комментарий Javadoc, но в других случаях исправить нарушение правила не так просто) .
Выглядит довольно утомительно, но для его игнорирования требуется явная конфигурация XML. Вероятно, вы можете найти графический интерфейс для этого с помощью плагина Checkstyle для Eclipse или Netbeans. Пример, который я нашел, находится на странице Checkstyle configuration.
<?xml version="1.0"?>
<!DOCTYPE suppressions PUBLIC
"-//Puppy Crawl//DTD Suppressions 1.1//EN"
"http://www.puppycrawl.com/dtds/suppressions_1_1.dtd">
<suppressions>
<suppress checks="JavadocStyleCheck"
files="AbstractComplexityCheck.java"
lines="82,108-122"/>
<suppress checks="MagicNumberCheck"
files="JavadocStyleCheck.java"
lines="221"/>
</suppressions>
Синтез указал на страницу конфигурации Checkstyle. Просматривая его, я обнаружил SuppressWithNearbyCommentFilter
, который кажется многообещающим, если я неправильно понял его назначение ...