«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.


2
Genel tip parametrelerini belgelemek için bir javadoc etiketi var mı?
Sun'ın sitesindeki javadoc belgelerine bakıyorum, bir sınıfın veya yöntemin genel tür imzasını belgelemek için kullanılabilecek bir javadoc etiketi olup olmadığını bulmaya çalışıyorum. Gibi bir şey @typeparamzamanki benzer @parammesela tiplerin yanı sıra yöntemlere ama uygulanabilir /** * @typeparam T This describes my type parameter */ class MyClass<T> { } Böyle bir …
165 java  javadoc 

4
Javadoc'u Python belgeleri için kullanma [kapalı]
Kapalı . Bu soru görüş temelli . Şu anda cevapları kabul etmiyor. Bu soruyu geliştirmek ister misiniz? Bu yayını düzenleyerek gerçekler ve alıntılarla yanıtlanabilmesi için soruyu güncelleyin . 2 yıl önce kapalı . Bu soruyu geliştir Şu anda Python ile başlıyorum ve güçlü bir PHP arka planım var ve PHP'de …

4
Android Studio: Javadoc fareyle üzerine gelindiğinde boş
Son zamanlarda Eclipse'den Android Studio'ya geçtim ve beğendim. Ancak, Eclipse'in üzerine gelindiğinde Javadoc'u özledim. İşlevleri eklemek için buradaki talimatları izledim , ancak hoverslerim Javadoc içermiyor. Doküman kısayolumu Ctrl+ Shift+ kullanırsam Spacedokümantasyonu doğru bir şekilde gösterecektir, ancak gerçekten Araç İpucu'nda gelmesini istiyorum. Aşağıda gördüklerimin bir ekran görüntüsü var. Açıkçası, bu yöntemde …



11
iyi Javadoc örneği [kapalı]
Kapalı. Bu soru Yığın Taşması yönergelerine uygun değil . Şu anda cevapları kabul etmiyor. Bu soruyu geliştirmek ister misiniz? Soruyu Yığın Taşması için konuyla ilgili olacak şekilde güncelleyin . 3 yıl önce kapalı . Bu soruyu geliştir Javadoc içeren bir kaynak dosya iyi bir örnek var mı? İnternette Javadoc'un birçok …
140 java  javadoc 

14
Simple Getter / Setter yorumları
Alıcıları ve ayarlayıcıları yorumlamak için hangi kuralı kullanıyorsunuz? Bu, bir süredir merak ettiğim bir şey, örneğin: /** * (1a) what do you put here? * @param salary (1b) what do you put here? */ public void setSalary(float salary); /* * (2a) what do you put here? * @return (2b) */ …


3
Javadoc kullanarak bir Enum Değerine @link nasıl oluşturulur
Javadoc 1.5 kullanarak, Numaralandırma değerine bir @ bağlantısı oluşturamadım. Yapmak istediğim şey, şöyle bir Enum oluşturmak: public enum Planet { /** * MERCURY is a fun place. */ MERCURY, /** * VENUS is more fun. */ VENUS, /** * But nothing beats the Earth. */ EARTH, /** * Others we …
121 java  javadoc 


3
Intellij IDEA, javadoc'u otomatik olarak gösterir
Netbeans'de kod yazarken, kodu otomatik olarak tamamlıyor ve Javadocs'u gösteriyor. Ancak Intellij IDEA'yı kullanırken Ctrl+ 'Space ya tıklarsam otomatik tamamlamayı görebilir ve Ctrl+'Q ya tıklarsam javadoc'u ayrı olarak görebilirim. Otomatik tamamlama gördüğümde veya Intellij IDEA'da Netbeans gibi Ctrl+Space 'a tıkladığımda Javadoc öğesini görmek mümkün mü ?

3
Netbeans: @author nasıl değiştirilir
Netbeans IDE'de yeni bir sınıf veya arabirim oluştururken, bir "@author ...." etiketi görünür. Değeri nasıl değiştirilir? Mümkünse, bazı yapılandırma dosyalarını düzenleyerek değil, Netbeans menüsünü kullanarak değiştirmek istiyorum :) Netbeans 7.2 kullanıyorum

4
JavaDoc'ta @see kullanımı?
Ne zaman kullanabilirim @seejavadocs uğraşırken? Kullanımı nedir? Örneğin eğer MethodAçağrılar MethodBsonra ben koymak zorunda yapmak @seeiçinde MethodB'nin javadoc ve referans MethodAişte bu dediği çünkü ya ben bir başvuru gerekiyor mu MethodBdan MethodAonu aradığını çünkü. @seeOracle web sitesindeki bilgileri okudum ve bana inanılmaz derecede belirsiz görünüyor, "ayrıca bakın" anlamına geldiğini söylüyor, …
110 java  methods  javadoc 

7
Uygulamaya Javadoc yorumları eklenmeli mi?
Arayüze Javadoc yorumları eklemek ve uygulamaya Javadoc olmayan yorumlar eklemek doğru bir uygulama mı? Çoğu IDE, yorumları otomatik olarak oluşturduğunuzda uygulamalar için JavaDoc olmayan yorumlar üretir. Somut yöntemin açıklaması olması gerekmez mi?

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.