1. ev
  2. Soru-cevap
  3. @code java ek açıklaması,

@code java ek açıklaması,

2013-10-10 32 views
15

nu yapar. Oracle belgelerinden, @code java ek açıklamasının ne yaptığını açıklamaya çalıştım. Bir önceki soruya itibaren @code java ek açıklaması,

, ben html ile ilgili bir şey olduğunu fark etti, ama ben

varsayılan javadoc tarafından HTML olarak ayrıştırılır olduğunu söylemek doğru olur tam olarak ne ... emin değilim. .. Bazı javadoc metninin yanına @code ek açıklamasını yerleştirmek, kod olarak ele alınması gerektiğini ve normal şekilde ayrıştırılmadığını/işlenmediğini gösterir mi? Yani örneğin: 

/** 
    *This is how to declare an int variable {@code int var=1;} 
    */

o kullanımına uygun bir örnek olabilir mi? Bir yöntem için JavaDocs eklemek istiyorsanız,

kaynak

2013-10-10 JMS

+0

Hangi kütüphaneden? –

+2

Sana Javadoc bazı açıklama beklediğini düşünüyorum: http://stackoverflow.com/questions/541920/multiple-line-code-example-in-javadoc-comment –

+0

[java kullanarak özel bir test koşucu oluştur ek açıklamalar] (http://www.singhajit.com/java-custom-annotations/) –

cevap

19

{@code }, Javadoc'a parantez içindeki metnin kod olduğunu ve HTML olarak işlem görmemesini söyleyen bir Javadoc etiketidir. Javadoc ayrıca metni diğer koddan farklı bir kod bloğunda biçimlendirmelidir. Bu, bir soru veya cevabı biçimlendirirken StackOverflow için editörün kullandığı "kod örneği" metnine çok benzer bir kavramdır.

kaynak

2013-10-10 17:33:02 dkatzel

+0

Java, varsayılan olarak kodu kod olarak kabul etmiyor mu? Bunu neden HTML olarak ele alıyor? – JMS

+1

JavaDoc, kodunuz hakkında HTML belgeleri oluşturmak için sınıflar, kurucular ve yöntemler üzerinde kullanabileceğiniz özel olarak biçimlendirilmiş bir yorumdur. Örneğin, Java API'si tamamen javaDoced'dir, böylece çevrimiçi veya IDE'nizi http://docs.oracle.com/javase/7/docs/api/ adresinde okuyabilirsiniz. Kendi başınıza nasıl yapılacağına dair ayrıntılar için bkz. Http: //docs.oracle.com/javase/6/docs/technotes/tools/windows/javadoc.html – dkatzel

1

. Belki

enter image description here

javadocs

vardır o zaman diğerleri için @code ile açıklama bir Javadoc gibi bir yöntem için kod eklemek istiyorsanız Yani sarı şey Javadoc burada olduğunu bilmiyorum Yöntemi bir örnek olarak görmek için yöntemi kullanmak. ve neden kullanmamız gerekiyor, çünkü eğer yapmazsak, biçimlendirme düzgün olmayacaktır

Eğer yoksa biçimlendirmede meydana gelen değişiklikleri kontrol etmek istiyorsanız, aşağıdaki soruya başvurabilirsiniz. : Multiple line code example in Javadoc comment

kaynak

2013-10-10 17:31:06

+0

Teşekkürler - bir örnek vererek açıklayabilir misiniz? – JMS

İlgili konular

 İlgili konular