Comment documenter les paramètres d'enregistrement Java?

Comment doit-on documenter les paramètres d' enregistrement Java ? Je fais référence aux paramètres qui finissent par devenir des paramètres constructeurs, des champs de classe.

J'ai essayé:

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

mais IntelliJ IDEA signale @params comme une erreur. Je n'ai pas pu trouver un exemple en ligne de la façon dont cela est censé fonctionner. La discussion la plus proche que j'ai trouvée est https://bugs.openjdk.java.net/browse/JDK-8225055 .

J'ai trouvé des tests unitaires dans le JDK qui semblent impliquer que cela devrait fonctionner. C'est peut-être un bug IDE?

J'utilise OpenJDK 14 + 36-1461, IDEA 2020.1.

J'ai déposé un rapport de bogue contre IDEA au cas où.

IntelliJ Bug / Missing Feature

En utilisant l'outil JDK intégré pour javadocavec la version 14-eaet au-dessus, je pouvais facilement générer Javadoc pour a record.

La commande utilisée pour la même chose est \

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

Ce serait donc certainement quelque chose qui manque dans IntelliJ. (Étant donné que l'option «Ajouter Javadoc» n'inclut pas non plus les composants.)

Je dois ajouter du point de vue du développement IntelliJ, bien sûr, car une fonction de prévisualisation priorisant le travail qui lui est consacré à ce point est également un appel qui doit être pris avec précaution.