Se scrivo <xmlElement> in una javadoc, non viene visualizzato, perché i tag hanno funzioni speciali sulla formattazione dei testi.Come posso utilizzare "<" and ">" in javadoc senza formattazione?
Come posso visualizzare questi caratteri in un javadoc?
È possibile utilizzare < per < e > per >.
è possibile utilizzare il pulsante "codice" per formattarlo '<' –
oppure è possibile utilizzare & per evitare il & – ILMTitan
@TomBrito Sebbene questo risponda alla domanda effettiva, credo che la necessità di sfuggire ai segni compaia solo quando essi sono usati come parentesi angolari (cioè a coppie), che a loro volta implicano che fanno parte di un codice (come un tag XML, come nel caso dell'OP). In questa situazione, credo che una soluzione migliore sia quella di avvolgere l'intero snippet XML nei tag '{@code ...}', come suggerito da Etienne Delavennat nella sua risposta. –
Hai solo bisogno di utilizzare l'equivalente HTML per una delle parentesi angolari. Lo < può essere rappresentato come < o <. Ecco un esempio tratto da vero Javadoc:
<pre>
<complexType>
<complexContent>
<restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
<sequence>
[...]
Questo mostra come:
<complexType>
<complexContent>
<restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
<sequence>
Versioni recenti del supporto JavaDoc {@literal A <B> C}; questo restituisce il contenuto correttamente (sfuggire allo '<' e '>' nell'HTML generato).
Vedi http://download.oracle.com/javase/1.5.0/docs/guide/javadoc/whatsnew-1.5.0.html
Considerando XML è codice vero e proprio, credo frammenti XML in Javadoc sono più adatti per il {@code A <B> C} tag piuttosto che il {@literal A <B> C} tag .
Il tag {@code} utilizza un carattere a larghezza fissa che rende il suo contenuto standout come codice effettivo.
Sono d'accordo. XML dovrebbe essere incluso nei tag '{@code}'. Verrà visualizzato in modo più naturale (con un font a larghezza fissa), e non sembrerà strano nel javadoc di origine, perché non è necessario sfuggire alle parentesi angolari separatamente. –
Se si set maven up to use markdown, è possibile circondarlo con i backtick.
`A<B>C` legge un po 'più bello {@code A<B>C}
correlati ma non del tutto una vittima: http://stackoverflow.com/questions/1782040/does-javadoc-have-an-equivalent-to-cdata – Pops