Comment créer plusieurs niveaux d'indentation dans Javadoc ?

Question

Supposons que, dans le cadre de la documentation de votre code (Javadoc), vous souhaitiez indiquer que les relations entre les éléments utilisant l'indentation profonde.

Comment puis-je créer une liste imbriquée en tant que :

• un élément
  • un autre élément
    • encore un autre élément

Answer 1

<ul>
  <li>Element</li>
  <ul>
     <li>Subelement...</li>

Vous pouvez utiliser assez librement du HTML dans les commentaires javadoc.

Mise à jour : parce que c'est arrivé, j'ai essayé

 <ul>
    <li>one</li>
    <ul>
        <li>one point one</li>
    </ul>   
</ul>

et obtenir

• une
  • un point un

Je suis d'accord qu'une bonne nidification est meilleure.

Answer 2

La manière correcte est la suivante :

 /**
 * <ul>
 *   <li>some element
 *   <li><ul>
 *     <li>some other element
 *     <li><ul>
 *       <li>yet some other element
 *     </ul>
 *   </ul>
 * </ul>
 */

Bien que JavaDoc emprunte au HTML, ce n'est pas du HTML et vous devez omettre les </li> , tout comme vous devez omettre les balises </p> .

Answer 3

La liste imbriquée doit être dans son propre <li> . <ul> n'est pas un élément enfant valide de <ul> .

Donc votre exemple serait :

 <ul>
  <li>some element</li>
  <li>
    <ul>
      <li>some other element</li>
      <li>
        <ul>
          <li>yet some other element</li>
        </ul>
      </li>
    </ul>
  </li>
</ul>