Bagaimana cara mendokumentasikan parameter Java Record?

12

Bagaimana orang seharusnya mendokumentasikan parameter Java Record ? Saya mengacu pada parameter yang akhirnya menjadi parameter konstruktor, bidang kelas.

Saya mencoba:

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

tetapi IntelliJ IDEA menandai @paramsebagai kesalahan. Saya tidak dapat menemukan contoh online tentang bagaimana ini seharusnya bekerja. Diskusi terdekat yang saya temukan adalah https://bugs.openjdk.java.net/browse/JDK-8225055 .

Saya menemukan beberapa unit test di JDK yang sepertinya menyiratkan ini harus bekerja. Mungkin ini bug IDE?

Saya menggunakan OpenJDK 14 + 36-1461, IDEA 2020.1.

Saya mengajukan laporan bug terhadap IDEA untuk berjaga-jaga.

Gili
sumber

Jawaban:

7

Fitur IntelliJ Bug / Hilang

Menggunakan alat JDK built-in untuk javadocdengan versi 14-eadan di atas, saya dapat dengan mudah menghasilkan Javadoc untuk record.

masukkan deskripsi gambar di sini

Perintah yang digunakan untuk hal yang sama adalah \

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

Jadi ini pasti akan menjadi sesuatu yang hilang di IntelliJ. (Karena opsi 'Tambahkan Javadoc' juga tidak termasuk komponen.)

Saya harus menambahkan dari sudut pandang pengembangan IntelliJ, tentu saja sebagai fitur pratinjau yang memprioritaskan pekerjaan yang didedikasikan untuk itu juga merupakan panggilan yang harus diambil dengan hati-hati.

Naman
sumber
1
Pembaruan - Rupanya, bug yang dilaporkan oleh penanya diterima untuk diperbaiki pada pelacak.
Naman