Come documentare i parametri di Java Record?


12

Come si può documentare i parametri del Record Java ? Mi riferisco ai parametri che finiscono per diventare parametri di costruzione, campi di classe.

Provai:

/**
 * @param name the name of the animal
 * @param age the age of the animal
 */
public record Animal(String name, int age)
{
}

ma IntelliJ IDEA contrassegna @params come errore. Non sono riuscito a trovare un esempio online di come dovrebbe funzionare. La discussione più vicina che ho trovato è https://bugs.openjdk.java.net/browse/JDK-8225055 .

Ho trovato alcuni test unitari nel JDK che sembrano implicare che dovrebbe funzionare. Forse questo è un bug IDE?

Sto usando OpenJDK 14 + 36-1461, IDEA 2020.1.

Ho presentato una segnalazione di bug contro IDEA per ogni evenienza.

Risposte:


7

IntelliJ Bug / Funzione mancante

Utilizzando lo strumento JDK integrato per javadocla versione 14-eae successive, ho potuto facilmente generare Javadoc per a record.

inserisci qui la descrizione dell'immagine

Il comando utilizzato per lo stesso è \

/jdk-14.jdk/.../javadoc --release=14 --enable-preview .../src/main/java/.../CityRecord.java

Quindi questo sarebbe sicuramente qualcosa che manca in IntelliJ. (Poiché anche l'opzione "Aggiungi Javadoc" non include i componenti.)

Devo aggiungere dal punto di vista dello sviluppo di IntelliJ, ovviamente come una funzione di anteprima che dà la priorità al lavoro dedicato ad esso a tal punto è anche un appello che deve essere preso con attenzione.


1
Aggiornamento - Apparentemente, il bug segnalato dall'asker è accettato per essere corretto sul tracker.
Naman,
Utilizzando il nostro sito, riconosci di aver letto e compreso le nostre Informativa sui cookie e Informativa sulla privacy.
Licensed under cc by-sa 3.0 with attribution required.