Come posso usare "<" e ">" in javadoc senza formattazione?

121

Se scrivo <xmlElement>in un javadoc, non appare, perché i tag hanno funzioni speciali sulla formattazione dei testi.

Come posso mostrare questi caratteri in un javadoc?

java javadoc

— Tom Brito
fonte

4

Correlato ma non proprio un idiota: stackoverflow.com/questions/1782040/…

— Pops

160

Puoi usare <per < e >per > .

— Pavitar Singh
fonte

oppure puoi usare & amp; per sfuggire alla &

— ILMTitan

14

@TomBrito Sebbene questo risponda alla domanda vera e propria, credo che la necessità di sfuggire ai segni appaia solo quando sono usati come parentesi angolari (cioè a coppie), il che a sua volta implica che fanno parte di un codice (come un tag XML, come nel caso di OP). In questa situazione, credo che una soluzione migliore sia racchiudere l'intero snippet XML in {@code ...}tag, come suggerito da Etienne Delavennat nella sua risposta.

— Zoltán

&gto &ltnon ha esattamente lo stesso significato con le parentesi angolari in formato XML. Ma {@code <>}è una scelta giusta.

— cinqS

63

Le versioni recenti di JavaDoc supportano {@literal A C}; questo restituisce il contenuto correttamente (evitando i caratteri "<" e ">" nell'HTML generato).

Vedi http://download.oracle.com/javase/1.5.0/docs/guide/javadoc/whatsnew-1.5.0.html

— Howard M. Lewis Ship
fonte

41

Considerando che XML è un codice effettivo, credo che gli snippet XML in Javadoc siano più adatti per il tag {@code A C} piuttosto che per il tag {@literal A C}.

Il tag {@code} utilizza un carattere a larghezza fissa che fa risaltare il suo contenuto come codice effettivo.

— Etienne Delavennat
fonte

2

Sono d'accordo. XML dovrebbe essere racchiuso in {@code }tag. Verrà visualizzato in modo più naturale (con un carattere a larghezza fissa) e non apparirà strano nel javadoc sorgente, perché non è necessario sfuggire alle parentesi angolari separatamente.

— Zoltán

15

Sfuggili come HTML: <e>

— duffymo
fonte

9

Devi solo utilizzare l'equivalente HTML per una delle parentesi angolari. La <può essere rappresentato come uno <o <. Ecco un esempio tratto dal vero Javadoc:

<Pre>
& Lt; complexType>
  & Lt; complexContent>
    & lt; restrizione base = "{http://www.w3.org/2001/XMLSchema}anyType">
      & Lt; sequenza>
      [...]

Viene visualizzato come:

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

— Pops
fonte

3

Se imposti Maven in modo che utilizzi il markdown , puoi semplicemente circondarlo di backtick.

`AC` legge un po 'meglio di {@code AC}

— Owen
fonte

2

L'interposizione di <pre> e {@code} salva parentesi angolari e linee vuote in javadocs ed è ampiamente utilizzata, vedere java.util.Stream per esempio.

<pre>{@code
   A<B>C

   D<E>F
}</pre>

— Serg
fonte

1

Basta circondarlo con {@code}questo:

{@code <xmlElement>}

— ivanjermakov
fonte