Как документировать параметры Java Record?

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 Bug / Missing Feature

Используя встроенный инструмент JDK для javadocверсии с версией 14-eaи выше, я мог легко сгенерировать Javadoc для a record.

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

Команда, используемая для того же, является \

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

Так что это, безусловно, чего-то не хватает в IntelliJ. (Поскольку опция «Добавить Javadoc» также не включает компоненты.)

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

Naman
источник
1
Обновление - по-видимому, ошибка, о которой сообщает аскер, принимается как исправленная на трекере.
Наман