Jak udokumentować parametry Java Record?


12

Jak należy udokumentować parametry Java Record ? Mam na myśli parametry, które ostatecznie stają się parametrami konstruktora, polami klas.

Próbowałem:

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

ale flagi IntelliJ IDEA @params jako błąd. Nie mogłem znaleźć internetowego przykładu tego, jak to ma działać. Najbliższa dyskusja, którą znalazłem, to https://bugs.openjdk.java.net/browse/JDK-8225055 .

Znalazłem kilka testów jednostkowych w JDK, które wydają się sugerować, że to powinno działać. Być może jest to błąd IDE?

Używam OpenJDK 14 + 36-1461, IDEA 2020.1.

Na wszelki wypadek złożyłem raport o błędzie przeciwko IDEA.

Odpowiedzi:


7

Błąd / brak funkcji IntelliJ

Używając wbudowanego narzędzia JDK dla javadocwersji 14-eai wyżej, mogłem łatwo wygenerować Javadoc dla record.

wprowadź opis zdjęcia tutaj

Poleceniem użytym do tego samego jest \

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

Tak więc na pewno w IntelliJ czegoś brakuje. (Ponieważ opcja „Dodaj Javadoc” również nie obejmuje składników).

Muszę dodać z punktu widzenia rozwoju IntelliJ, oczywiście jako funkcja podglądu, w której priorytetem są prace poświęcone temu zadaniu, jest również wezwaniem, które należy podjąć ostrożnie.


1
Aktualizacja - Najwyraźniej błąd zgłoszony przez pytającego jest akceptowany jako naprawiony w module śledzącym.
Naman
Korzystając z naszej strony potwierdzasz, że przeczytałeś(-aś) i rozumiesz nasze zasady używania plików cookie i zasady ochrony prywatności.
Licensed under cc by-sa 3.0 with attribution required.