Java Kayıt parametreleri nasıl belgelenir?


12

Java Kayıt parametrelerini nasıl belgelemek gerekir ? Ben yapıcı parametreleri, sınıf alanları haline sonunda parametreleri atıfta bulunuyorum.

Denedim:

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

ancak IntelliJ IDEA @parambir hata olarak işaretler . Bunun nasıl çalışması gerektiğine dair çevrimiçi bir örnek bulamadım. Bulduğum en yakın tartışma https://bugs.openjdk.java.net/browse/JDK-8225055 .

JDK'da bunun çalışması gerektiğini ima eden bazı birim testleri buldum . Belki de bu bir IDE hatasıdır?

OpenJDK 14 + 36-1461, IDEA 2020.1 kullanıyorum.

Her ihtimale karşı IDEA'ya karşı bir hata raporu hazırladım .

Yanıtlar:


7

IntelliJ Hata / Eksik Özellik

javadocSürüm 14-eave üzeri ile yerleşik JDK aracını kullanarak, kolayca bir için Javadoc oluşturabilir record.

resim açıklamasını buraya girin

Aynı için kullanılan komut \

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

Bu IntelliJ'de kesinlikle eksik bir şey olurdu. ('Javadoc Ekle' seçeneği bileşenleri içermediğinden.)

IntelliJ geliştirme bakış açısından, elbette, ona yönelik çalışmayı bu ölçüde önceliklendiren bir önizleme özelliği olarak dikkatle alınması gereken bir çağrı da eklemeliyim.


1
Güncelleme - Görünüşe göre, asker tarafından bildirilen hatanın izleyicide Sabit olduğu kabul edildi.
Naman
Sitemizi kullandığınızda şunları okuyup anladığınızı kabul etmiş olursunuz: Çerez Politikası ve Gizlilik Politikası.
Licensed under cc by-sa 3.0 with attribution required.