Решение для многословия 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

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

В зависимости от того, хотите ли вы просто отфильтровать Javadoc для геттера и сеттера или что-то более сложное, это может быть лучшим, более чистым решением.

Answer 2

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

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

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