Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

[Checkstyle] Javadoc parameter alignment check does not work with link tags

Aperta Adatta ai principianti
  • Qualcosa non va?
#14,405 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
78/100
Tipo di issue
Bug
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
java
Ambito
testing

Direzione di ricerca

Nel modulo checkstyle, esamina il controllo JavadocParamAlignment e i relativi dati di test; l’issue fornisce un esempio Javadoc che riproduce il problema e le diagnostiche di colonna errate. Esegui i test pertinenti di JavadocParamAlignment, aggiungi il caso e indaga sul motivo per cui il testo dei tag di collegamento influisce sull’allineamento. Il lavoro è completato quando il nuovo caso passa insieme a method_multiline_correct.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

type: bug

The custom checkstyle task that enforces param alignment doesn't seem to work with link (and probably other types of) tags.

To reproduce, add the following test case to JavadocParamAlignment in the checkstyle module's test data:

    /**
     * A method that does something
     *
     * @param a                  this is a description
     *                           with a {@link #method(String, String)} link tag
     * @param superLongParamName a description
     *                           blabla
     */
    public void method_multiline_correct_with_link(String a, String superLongParamName) {
    }

and run the tests. I'd expect it to pass just like method_multiline_correct passes, but it currently does not.

Test output:

Violations do not match for src\testData\java\testdata\JavadocParamAlignment.java
Violations not accounted for in test: 
  51:34: Param description for a should start at column 73
  52:34: Param description for a should start at column 73
  53:34: Param description for superLongParamName should start at column 73
  54:34: Param description for superLongParamName should start at column 73
Lingua principale
Java
Stelle
12.7k
Fork
3.5k
Merge medio
2g 13h
PR unite (30g)
46

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di PaperMC/Paper

Tutte le issue di PaperMC/Paper

Issue simili

Altre issue su Java

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.