«javadoc» etiketlenmiş sorular

Javadoc, Java kaynak kodunda özel olarak biçimlendirilmiş yorumları okuyan ve derlenmiş belgeler üreten genişletilebilir bir belge oluşturma sistemidir. Genellikle HTML web sayfaları biçiminde API belgeleri üretmek için kullanılır.


4
Özelliklerin Javadoc'u nasıl yazılır?
Sadece özellikleri ve alıcıları ve ayarlayıcıları (DTO tarzı) tutan "basit" bir POJO sınıfının özellikleri / üyeleri için javadoc yazarken sık sık kendimi bir ikilemle buluyorum ... 1) Mülk için javadoc yazın veya ... 2) Alıcı için javadoc yazın Özellik için javadoc yazarsam, IDE'm (Eclipse) daha sonra kod tamamlama yoluyla POJO'ya …
93 java  javadoc 

4
Intellij'de @author'un otomatik tamamlanması
Eclipse'den Intellij Idea'ya geçiyorum. Henüz anlayamadığım bir şey, @authorJavaDoc etiketinin otomatik olarak tamamlanması . @aEclipse'de yazarken iki öneri vardır: @author - author name @author Intellij'de ilk teklifi nasıl elde ederim (bu mümkün mü?)? Ve eğer mümkünse, yazar adı yer tutucusu için eklenen şablonun şablonunu nasıl değiştirebilirim?

1
@See ve @inheritDoc arasındaki farkın ayrıntıları
JavaDoc referansına baktım ve @see(çeşitli bağlantılar) ve {@inheritDoc}(süper sınıf JavaDoc yorumunun dışa aktarımı ) arasındaki temel farkı anlarken, şeylerin gerçekte nasıl uygulandığına dair açıklamaya ihtiyacım var. Eclipse IDE'de, miras alınan yöntem için (arabirimden veya toString () geçersiz kılma vb.) İçin "Öğe Yorumları Oluştur" u seçtiğimde, aşağıdaki yorumu oluşturuyor /* (non-Javadoc) …
90 java  javadoc  comments 


3
JDK 11+ ve Javadoc
Exit code: 1 - javadoc: error - The code being documented uses packages in the unnamed module, but the packages defined in https://docs.oracle.com/en/java/javase/11/docs/api/ are in named modules. Herkes kaynak sürümünü 1.8 (diğer forumlarda önerildiği gibi) değiştirmek zorunda kalmadan javadoc çalışmasını mümkün mü? JDK v11.0.5 kullanıyorum ve sorun hala devam ediyor …

1
Java Kayıt parametreleri nasıl belgelenir?
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 …
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.