Как документировать Java Параметры записи? - PullRequest
Новая
       50

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

12 голосов
/ 26 апреля 2020

Как можно документировать Java Запись параметров? Я имею в виду параметры, которые в конечном итоге становятся параметрами конструктора, полями классов.

Я пытался: 

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

, но IntelliJ IDEA помечает @param s как ошибку. Я не смог найти онлайн пример того, как это должно работать. Самое близкое обсуждение, которое я нашел, это https://bugs.openjdk.java.net/browse/JDK-8225055.

Я нашел несколько unit тестов в JDK, которые, кажется, подразумевают, что это должно работать , Возможно, это ошибка IDE?

Я использую OpenJDK 14 + 36-1461, IDEA 2020.1.

Я подал отчет об ошибке против IDEA на всякий случай.

1 Ответ

8 голосов
/ 27 апреля 2020

IntelliJ Bug / Missing Feature

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

enter image description here

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

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

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

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

...