Como documentar os parâmetros do Java Record?

12

Como se deve documentar os parâmetros do Java Record ? Estou me referindo aos parâmetros que acabam se tornando parâmetros construtores, campos de classe.

Eu tentei:

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

mas o IntelliJ IDEA sinaliza @params como um erro. Não consegui encontrar um exemplo on-line de como isso deve funcionar. A discussão mais próxima que encontrei é https://bugs.openjdk.java.net/browse/JDK-8225055 .

Encontrei alguns testes de unidade no JDK que parecem sugerir que isso deveria estar funcionando. Talvez este seja um bug do IDE?

Estou usando o OpenJDK 14 + 36-1461, IDEA 2020.1.

Eu enviei um relatório de bug contra a IDEA por precaução.

Gili
fonte

Respostas:

7

Bug do IntelliJ / recurso ausente

Usando a ferramenta JDK incorporada para javadoca versão 14-eae acima, eu poderia facilmente gerar Javadoc para a record.

insira a descrição da imagem aqui

O comando usado para o mesmo é \

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

Portanto, isso certamente seria algo que falta no IntelliJ. (Como a opção 'Adicionar Javadoc' também não inclui os componentes).

Devo acrescentar do ponto de vista do desenvolvimento do IntelliJ, é claro que um recurso de visualização que priorize o trabalho dedicado a ele a tal ponto também é uma chamada que deve ser tomada com cuidado.

Naman
fonte
11
Atualização - Aparentemente, o bug relatado pelo solicitante é aceito como corrigido no rastreador.
Naman 29/04