Comment puis-je utiliser "<" et ">" en javadoc sans formatage ?

Question

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

Comment puis-je montrer ces chars dans un javadoc ?

Answer 1

Vous pouvez utiliser < pour < et > pour >.

Answer 2

Les versions récentes de JavaDoc supportent {@literal A<B>C} ; cela produit le contenu correctement (échappant aux '<' et '>' dans le HTML généré).

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

Answer 3

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

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

Answer 4

Échappez-les en HTML : < et >

Answer 5

Vous n'avez besoin d'utiliser l'équivalent HTML que pour l'une des parenthèses angulaires. Le < peut être représenté comme < ou <. Voici un échantillon tiré de Real Javadoc :

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


  
    
      
      

Ceci s'affiche comme suit :

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