Як документувати параметри запису Java?


12

Як слід документувати параметри запису Java ? Я маю на увазі параметри, які в кінцевому підсумку стають параметрами конструктора, полями класу.

Я намагався:

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

але IntelliJ IDEA позначає @params як помилку. Не вдалося знайти в Інтернеті приклад того, як це має працювати. Найближча дискусія, яку я знайшов, - https://bugs.openjdk.java.net/browse/JDK-8225055 .

Я знайшов кілька модульних тестів в JDK , які , здається, має на увазі , це повинно працювати. Можливо, це помилка IDE?

Я використовую OpenJDK 14 + 36-1461, IDEA 2020.1.

Я подав повідомлення про помилку проти IDEA на всякий випадок.

Відповіді:


7

Помилка / відсутність функції IntelliJ

Використовуючи вбудований інструмент JDK для javadocверсії 14-eaта вище, я міг би легко створити Javadoc для record.

введіть тут опис зображення

Команда, яка використовується для того ж, \

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

Тож це, безумовно, щось не вистачало б в IntelliJ. (Оскільки опція "Додати Javadoc" також не включає компоненти.)

Я мушу додати з точки зору розвитку IntelliJ, звичайно, що функція попереднього перегляду, яка надає пріоритетну роботу, присвячену їй до такої міри, також є закликом, який потрібно уважно сприймати.


1
Оновлення - Мабуть, помилку, про яку повідомляє запитувач, прийнято виправляти на трекері.
Наман
Використовуючи наш веб-сайт, ви визнаєте, що прочитали та зрозуміли наші Політику щодо файлів cookie та Політику конфіденційності.
Licensed under cc by-sa 3.0 with attribution required.