Comment puis-je utiliser "<" et ">" dans javadoc sans formatage?
Si j'écris <xmlElement> dans un javadoc, il n'apparaît pas, car les balises ont des fonctions spéciales sur la mise en forme des textes.
Comment puis-je afficher ces caractères dans un javadoc?
Vous pouvez utiliser < pour < et > pour >.
Les versions récentes de JavaDoc prennent en charge {@literal A <B> C}; cela renvoie 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
Étant donné que XML est du code réel, je pense que les extraits XML dans Javadoc conviennent mieux à la balise {@code A <B> C} qu'à la balise {@literal A <B> C}.
La balise {@code} utilise une police à largeur fixe qui fait ressortir son contenu en tant que code réel.
Échappez-les au format HTML: < et >
Il vous suffit d'utiliser l'équivalent HTML pour l'un des crochets angulaires. Le < peut être représenté par < ou <. Voici un échantillon tiré de la vraie Javadoc:
<pre>
lt; complexType>
lt; complexContent>
lt; restriction base = "{http://www.w3.org/2001/ XMLSchema} anyType ">
Lt; sequence>
[...]
Cela s'affiche comme:
<complexType>
<complexContent>
<restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
<sequence>
Si vous configurez maven pour utiliser la démarque , vous pouvez simplement l'entourer de backticks.
`A<B>C` lit un peu mieux que {@code A<B>C}