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 utilisent une indentation profonde.

Comment puis-je créer une liste imbriquée comme:

• 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 le HTML dans les commentaires javadoc.

Mise à jour: Parce qu'il est venu, 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 que la bonne imbrication est meilleure.

Answer 2

La bonne façon 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 à HTML, ce n'est pas HTML, et vous devez omettre le </li> tags, tout comme vous devez omettre </p> Mots clés.

Answer 3

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

Votre exemple serait donc:

<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>