¿Cómo puedo usar “<” y “>” en javadoc sin formatear?

121

Si escribo <xmlElement>en un javadoc, no aparece, porque las etiquetas tienen funciones especiales para formatear textos.

¿Cómo puedo mostrar estos caracteres en un javadoc?

java javadoc

— Tom Brito
fuente

4

Relacionado pero no del todo engañado: stackoverflow.com/questions/1782040/…

— Pops

160

Puede utilizar <para < y >para > .

— Pavitar Singh
fuente

o puede utilizar & amp; para escapar del &

— ILMTitan

14

@TomBrito Aunque esto responde a la pregunta real, creo que la necesidad de escapar de los signos aparece solo cuando se usan como paréntesis angulares (es decir, en pares), lo que a su vez implica que son parte de algún código (como una etiqueta XML, como en el caso de OP). En esta situación, creo que una mejor solución es envolver todo el fragmento XML en {@code ...}etiquetas, como sugirió Etienne Delavennat en su respuesta.

— Zoltán

&gto &ltno tiene exactamente el mismo significado con los corchetes angulares en formato XML. Pero {@code <>}es una elección acertada.

— cinqS

63

Las versiones recientes de JavaDoc son compatibles con {@literal A C}; esto genera el contenido correctamente (escapando de '<' y '>' en el HTML generado).

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

— Barco Howard M. Lewis
fuente

41

Teniendo en cuenta que XML es código real, creo que los fragmentos de XML en Javadoc son más adecuados para la etiqueta {@code A C} que para la etiqueta {@literal A C}.

La etiqueta {@code} usa una fuente de ancho fijo que hace que su contenido destaque como código real.

— Etienne Delavennat
fuente

2

Estoy de acuerdo. XML debe estar envuelto en {@code }etiquetas. Se mostrará de forma más natural (con una fuente de ancho fijo) y no se verá extraño en el javadoc fuente, porque no tiene que escapar de los corchetes angulares por separado.

— Zoltán

15

Escápelos como HTML: <y>

— duffymo
fuente

9

Solo necesita usar el equivalente HTML para uno de los corchetes angulares. Se <puede representar como <o <. Aquí hay una muestra tomada de Javadoc real:

<pre>
& lt; complexType>
  & lt; complexContent>
    & lt; restriction base = "{http://www.w3.org/2001/XMLSchema}anyType">
      & lt; secuencia>
      [...]

Esto se muestra como:

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

— Pops
fuente

3

Si configura maven para usar markdown , puede rodearlo con comillas invertidas.

`AC` lee un poco mejor que {@code AC}

— Owen
fuente

2

La interposición de <pre> y {@code} guarda corchetes angulares y líneas vacías en javadocs y se usa ampliamente; consulte java.util.Stream por ejemplo.

<pre>{@code
   A<B>C

   D<E>F
}</pre>

— Serg
fuente

1

Solo rodéalo {@code}así:

{@code <xmlElement>}

— ivanjermakov
fuente