Решение для многословия Checkstyle?

Question

В образце коды, содержащем множество получателей и установщик существует следующее Checkstyle обозначения:

/* CHECKSTYLE:OFF */ 
public void setDisplayName(final String displayName) { 
    this.displayName = displayName; 
} 
/* CHECKSTYLE:ON */ 

/* CHECKSTYLE:OFF */ 
public String getDisplayName() { 
    return displayName; 
} 
/* CHECKSTYLE:ON */ 

Я считаю, что это мутит код, что делает его более трудным для чтения.

Есть ли более простой способ добавить эти обозначения, чтобы они не были в начале и конце каждого определения метода, как в этом примере?

Answer 1

Обозначение, которое вы называете, называется SuppressionCommentFilter, которое использует пары комментариев для подавления событий аудита. Вместо того, чтобы эти подавлениями в коде вы можете сохранить их в отдельном файле, как описано в этой ссылке: SuppressionFilter

Однако есть основания для поддержания его в коде, в зависимости от обстоятельств:

Если это вопрос кода в вопрос, а не личное предпочтение, Лучшее место для переопределения политики находится в самом коде. Полуструктурированные комментарии могут быть связаны с проверкой . Это иногда превосходит отдельный файл запретов , который должен быть обновлен до по мере удаления исходного файла .

Answer 2

Вы пробовали обновить свой Javadoc method Checkstyle configuration не требуется Javadoc на добытчиками и сеттеров, используя свойство allowMissingPropertyJavadoc?

В зависимости от того, после фильтрации фильтра и установки javadoc или чего-то более сложного, это может быть лучшим, более чистым решением.