Biçimlendirmeden javadoc'ta "<" ve ">" yi nasıl kullanabilirim?

121

Ben yazarsam <xmlElement>bir javadoc etiketleri biçimlendirme metinler üzerinde özel fonksiyonlara sahip, çünkü, görünmüyor.

Bu karakterleri javadoc'ta nasıl gösterebilirim?

java javadoc

— Tom Brito
kaynak

4

Alakalı, ancak tam tersi değil: stackoverflow.com/questions/1782040/…

— Pops

160

Sen kullanabilirsiniz <için < ve >için > .

— Pavitar Singh
kaynak

ya da & amp; &

— ILMTitan'dan

14

@TomBrito Bu, asıl soruyu yanıtlasa da, işaretlerden kaçmanın gerekliliğinin yalnızca açılı parantez olarak kullanıldıklarında (yani çiftler halinde) ortaya çıktığına inanıyorum, bu da bazı kodların (XML etiketi gibi, OP'nin durumunda olduğu gibi). Bu durumda, {@code ...}Etienne Delavennat'ın cevabında önerdiği gibi , tüm XML pasajını etiketlere sarmanın daha iyi bir çözüm olduğuna inanıyorum .

— Zoltán

&gtveya &ltXML biçimindeki açılı parantezlerle tam olarak aynı anlama gelmez. Ama {@code <>}doğru bir seçim.

— cinqS

63

JavaDoc desteğinin son sürümleri {@literal A C}; bu, içeriği doğru bir şekilde verir (oluşturulan HTML'deki '<' ve '>' karakterlerinden kaçar).

Bkz. Http://download.oracle.com/javase/1.5.0/docs/guide/javadoc/whatsnew-1.5.0.html

— Howard M. Lewis Gemisi
kaynak

41

XML'in gerçek kod olduğu düşünüldüğünde, Javadoc'taki XML parçacıklarının {@literal A C} etiketi yerine {@code A C} etiketi için daha uygun olduğuna inanıyorum.

{@Code} etiketi, içeriğini gerçek kod olarak öne çıkaran sabit genişlikli bir yazı tipi kullanır.

— Etienne Delavennat
kaynak

2

Katılıyorum. XML {@code }etiketlere sarılmalıdır . Daha doğal bir şekilde (sabit genişlikte bir yazı tipiyle) görüntülenecek ve javadoc kaynağında tuhaf görünmeyecektir, çünkü açılı ayraçlardan ayrı ayrı çıkmak zorunda değilsiniz.

— Zoltán

15

Bunlardan HTML olarak çıkın: <ve>

— duffymo
kaynak

9

Köşeli parantezlerden biri için yalnızca HTML eşdeğerini kullanmanız gerekir. <Ya olduğu gibi temsil edilebilir <ya da <. İşte gerçek Javadoc'tan alınan bir örnek:

<Pre>
& Lt; complexType>
  & Lt; complexContent>
    & lt; kısıtlama base = "{http://www.w3.org/2001/XMLSchema}anyType">
      & Lt; sekansı>
      [...]

Bu şu şekilde görüntülenir:

<complexType>
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>

— babalık
kaynak

3

Eğer maven'i markdown kullanmak için ayarlarsanız , onu sadece backticks ile çevreleyebilirsiniz.

`AC` şundan biraz daha güzel okur {@code AC}

— Owen
kaynak

3

<pre> ve {@code} birleşimi, javadocs'ta açılı ayraçları ve boş satırları kaydeder ve yaygın olarak kullanılır, örneğin bkz. Java.util.Stream.

<pre>{@code
   A<B>C

   D<E>F
}</pre>

— Serg
kaynak

1

Sadece şöyle kuşatın {@code}:

{@code <xmlElement>}

— ivanjermakov
kaynak