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

88

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
James Raitsev
la source

Réponses:

132
<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 venu, j'ai essayé

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

et obtenir

  • un
    • un point un

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

Charlie Martin
la source
2
Je dirais que <ul> imbriqué doit être dans un élément <li>, pour comparaison, voir w3.org/wiki/HTML_lists#Nesting_lists
user2622016
Vous pouvez dire cela, mais l'essayer en dit long.
Charlie Martin
1
@Charlie Au lieu de dire "Je suis d'accord qu'une bonne imbrication est meilleure.", Vous pourriez peut-être écrire un exemple montrant comment bien imbriquer? Sinon, peut-être qu'un débutant ne comprendra pas votre commentaire et utilisera le formulaire ci-dessus.
Rauni Lillemets
2
J'ai compris que user2622016 signifiait que vous devez écrire comme ceci: <ul><li><ul>...</ul></li> </ul>, de sorte que le plus profond <ul> .. </ ul > est également à l'intérieur d'un bloc <li> .. </li>.
Rauni Lillemets
1
Bien que je ne puisse pas le trouver explicitement déclaré (et j'ai regardé), c'est le style qui est utilisé dans la documentation d'Oracle . De plus, NetBeans s'en plaint. Intellij, d'autre part, ajoute heureusement les </li>balises
SeverityOne
28

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>balises, tout comme vous devez omettre les </p>balises.

SeverityOne
la source
1
Des références pour l'omission des balises de fermeture?
friederbluemle
1
Oui, ici: oracle.com/technetwork/java/javase/documentation/… - bien que ce soit implicite plutôt qu'explicite.
SeverityOne
Je ne comprends pas pourquoi cette réponse n'a pas plus de votes positifs.
John Smith
8

La liste imbriquée doit être dans la sienne <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>
Drew Noakes
la source
Votre code aboutit à une liste d'éléments vides. Bien qu'il soit correctement imbriqué dans HTML, le résultat rendu est moche.
naXa