Si escribo <xmlElement> en un javadoc, no aparece, porque las etiquetas tienen funciones especiales para formatear textos.¿Cómo puedo usar "<" and ">" en javadoc sin formatear?
¿Cómo puedo mostrar este carácter en un javadoc?
Usted puede utilizar < para < y > para >.
puede usar el botón "código" para formatearlo '' –
o puede usar & para escapar de & – ILMTitan
@TomBrito Aunque esto responde a la pregunta real, creo que la necesidad de escapar de los signos aparece solo cuando se utilizan como paréntesis angulares (es decir, en pares), lo que a su vez implica que forman 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 las etiquetas '{@code ...}', como sugirió Etienne Delavennat en su respuesta. –
Sólo tiene que utilizar el equivalente HTML para uno de los paréntesis angulares. El < se puede representar como < o <. He aquí una muestra tomada de Javadoc real:
<pre>
<complexType>
<complexContent>
<restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
<sequence>
[...]
Esto muestra como:
<complexType>
<complexContent>
<restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
<sequence>
Versiones recientes del soporte de JavaDoc {@literal A <B> C}; esto muestra 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
XML Teniendo en cuenta es el código real, creo fragmentos XML en Javadoc son más adecuados para la {@code Un <B> C} etiqueta en lugar de la @literal {A <B> C} etiqueta .
La etiqueta {@code} usa una fuente de ancho fijo que resalta su contenido como código real.
Estoy de acuerdo. XML debe estar envuelto en etiquetas '{@code}'. Se mostrará de forma más natural (con una fuente de ancho fijo), y no se verá extraño en la fuente javadoc, ya que no tiene que escapar de los corchetes angulares por separado. –
Si set maven up to use markdown, puede simplemente rodearlo con palos de retroceso.
`A<B>C` lee un poco mejor que {@code A<B>C}
relacionada, pero no es una víctima: http://stackoverflow.com/questions/1782040/does-javadoc-have-an-equivalent-to-cdata – Pops