Soluzione per Checkstyle prolissità?

Question

In un esempio di codice che contiene molte getter e setter, le seguenti notazioni Checkstyle esistono:

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

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

Trovo che questo infanga il codice, rendendo più difficile da leggere.

C'è un modo più semplice per aggiungere queste notazioni in modo che essi non sono all'inizio e alla fine di ogni definizione di metodo come in questo esempio?

Answer 1

La notazione si fa riferimento a è chiamato SuppressionCommentFilter che utilizza coppie di commenti a eventi di controllo sopprimere. Invece di avere queste soppressioni nel codice si poteva mantenerli in un file separato, come è spiegato in questo link: SuppressionFilter

Per quanto ci sono ragioni per mantenere nel codice, a seconda della circostanza:

  

Quando si tratta di una questione di codice in   domanda e la preferenza non è personale,   il posto migliore per sostituire la politica   è nel codice stesso. Semi-strutturati   commenti possono essere associati con il   dai un'occhiata. Questo è a volte superiore ad una   file di soppressioni separato, che deve   essere sempre aggiornato del file di origine   viene modificato.

Answer 2

Hai provato l'aggiornamento del metodo di Javadoc Checkstyle configurazione per non richiede javadoc sul getter e setter utilizzando la proprietà allowMissingPropertyJavadoc?

A seconda se siete dopo appena filtrando il getter e setter javadoc o qualcosa di più complicato, questo può essere una migliore, soluzione più pulita.