Comment puis-je utiliser «<» et «>» dans javadoc sans formatage?

121

Si j'écris <xmlElement>dans un javadoc, cela n'apparaît pas, car les balises ont des fonctions spéciales sur le formatage des textes.

Comment puis-je afficher ces caractères dans un javadoc?

java javadoc

— Tom Brito
source

4

En relation mais pas tout à fait une dupe: stackoverflow.com/questions/1782040/…

— Pop

160

Vous pouvez utiliser <pour < et >pour > .

— Pavitar Singh
source

ou vous pouvez utiliser & amp; pour échapper au &

— ILMTitan

14

@TomBrito Bien que cela réponde à la question réelle, je pense que la nécessité d'échapper aux signes n'apparaît que lorsqu'ils sont utilisés comme crochets angulaires (c'est-à-dire par paires), ce qui implique à son tour qu'ils font partie d'un code (comme une balise XML, comme dans le cas d'OP). Dans cette situation, je pense qu'une meilleure solution consiste à envelopper l'extrait de code XML entier dans des {@code ...}balises, comme l'a suggéré Etienne Delavennat dans sa réponse.

— Zoltán

&gtou &ltn'a pas exactement la même signification avec les crochets angulaires au format XML. Mais {@code <>}c'est un bon choix.

— cinqS

63

Prise en charge des versions récentes de JavaDoc {@literal A C}; cela affiche le contenu correctement (en échappant les '<' et '>' dans le HTML généré).

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

— Navire Howard M. Lewis
source

41

Considérant que XML est du code réel, je pense que les extraits de code XML dans Javadoc sont mieux adaptés pour la balise {@code A C} plutôt que pour la balise {@literal A C}.

La balise {@code} utilise une police à largeur fixe qui fait ressortir son contenu en tant que code réel.

— Etienne Delavennat
source

2

Je suis d'accord. XML doit être entouré de {@code }balises. Il sera affiché plus naturellement (avec une police à largeur fixe), et il n'aura pas l'air bizarre dans le javadoc source, car vous n'avez pas à échapper aux crochets angulaires séparément.

— Zoltán

15

Échappez-les au format HTML: <et>

— duffymo
source

9

Il vous suffit d'utiliser l'équivalent HTML pour l'un des crochets angulaires. Le <peut être représenté par <ou par <. Voici un échantillon tiré du vrai Javadoc:

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

Cela s'affiche comme:

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

— Pops
source

3

Si vous configurez maven pour utiliser le démarquage , vous pouvez simplement l'entourer de backticks.

`AC` lit un peu mieux que {@code AC}

— Owen
source

2

L'interposition de <pre> et {@code} enregistre les crochets angulaires et les lignes vides dans les javadocs et est largement utilisée, voir java.util.Stream par exemple.

<pre>{@code
   A<B>C

   D<E>F
}</pre>

— Serg
source

1

Entourez-le simplement {@code}comme ceci:

{@code <xmlElement>}

— Ivanjermakov
source