¿Cómo documentar los parámetros de Java Record?


12

¿Cómo se supone que se deben documentar los parámetros de Java Record ? Me refiero a los parámetros que terminan convirtiéndose en parámetros de constructor, campos de clase.

Lo intenté:

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

pero IntelliJ IDEA marca @params como un error. No pude encontrar un ejemplo en línea de cómo se supone que esto funciona. La discusión más cercana que encontré es https://bugs.openjdk.java.net/browse/JDK-8225055 .

Encontré algunas pruebas unitarias en el JDK que parecen implicar que esto debería estar funcionando. Tal vez esto es un error IDE?

Estoy usando OpenJDK 14 + 36-1461, IDEA 2020.1.

Presenté un informe de error contra IDEA por si acaso.

Respuestas:


7

IntelliJ Bug / Función faltante

Utilizando la herramienta JDK incorporada para javadocla versión 14-eay superior, podría generar fácilmente Javadoc para a record.

ingrese la descripción de la imagen aquí

El comando utilizado para el mismo es \

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

Por lo tanto, esto sería algo que falta en IntelliJ. (Dado que la opción 'Agregar Javadoc' tampoco incluye los componentes).

Debo agregar desde el punto de vista del desarrollo de IntelliJ, por supuesto, como una función de vista previa que prioriza el trabajo dedicado a tal medida, también es una llamada que debe tomarse con cuidado.


1
Actualización - Aparentemente, el error reportado por el autor de la pregunta se acepta como solucionado en el rastreador.
Naman
Al usar nuestro sitio, usted reconoce que ha leído y comprende nuestra Política de Cookies y Política de Privacidad.
Licensed under cc by-sa 3.0 with attribution required.