Wie dokumentiere ich Java Record-Parameter?

12

Wie soll man Java Record Parameter dokumentieren ? Ich beziehe mich auf die Parameter, die letztendlich zu Konstruktorparametern werden, Klassenfeldern.

Ich habe es versucht:

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

IntelliJ IDEA kennzeichnet @params jedoch als Fehler. Ich konnte kein Online-Beispiel dafür finden, wie dies funktionieren soll. Die nächste Diskussion, die ich gefunden habe, ist https://bugs.openjdk.java.net/browse/JDK-8225055 .

Ich fand einige Einheit Tests in JDK dies zu bedeuten scheinen sollte funktionieren. Vielleicht ist dies ein IDE-Fehler?

Ich verwende OpenJDK 14 + 36-1461, IDEA 2020.1.

Ich habe für alle Fälle einen Fehlerbericht gegen IDEA eingereicht .

Gili
quelle

Antworten:

7

IntelliJ Bug / Missing Feature

Mit dem eingebauten JDK-Tool für javadocdie Version 14-eaund höher konnte ich problemlos Javadoc für a generieren record.

Geben Sie hier die Bildbeschreibung ein

Der dafür verwendete Befehl lautet \

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

Dies würde also sicherlich in IntelliJ fehlen. (Da die Option 'Javadoc hinzufügen' auch die Komponenten nicht enthält.)

Ich muss aus der Sicht der IntelliJ-Entwicklung hinzufügen, dass eine Vorschau-Funktion, die die dafür vorgesehene Arbeit in einem solchen Ausmaß priorisiert , natürlich auch ein Aufruf ist, der sorgfältig angenommen werden muss.

Naman
quelle
1
Update - Anscheinend wird angenommen, dass der vom Fragesteller gemeldete Fehler im Tracker behoben ist.
Naman