Jak utworzyć wiele poziomów wcięć w Javadoc?

88

Załóżmy, że w ramach dokumentowania kodu (Javadoc) chcesz wskazać relacje między elementami za pomocą głębokich wcięć.

Jak mogę utworzyć zagnieżdżoną listę jako:

  • jakiś element
    • jakiś inny element
      • jeszcze jakiś inny element
James Raitsev
źródło

Odpowiedzi:

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

Możesz całkiem swobodnie używać HTML w komentarzach javadoc.

Aktualizacja: Ponieważ wyszło, próbowałem

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

i dostać

  • jeden
    • jeden punkt jeden

Zgadzam się, że właściwe zagnieżdżenie jest lepsze.

Charlie Martin
źródło
2
Powiedziałbym, że zagnieżdżone <ul> musi znajdować się wewnątrz jakiegoś elementu <li>, dla porównania patrz w3.org/wiki/HTML_lists#Nesting_lists
user2622016
Możesz to powiedzieć, ale próbowanie tego mówi coś innego.
Charlie Martin,
1
@Charlie Zamiast mówić „Zgadzam się, że prawidłowe zagnieżdżenie jest lepsze.”, Może mógłbyś napisać przykład pokazujący, jak prawidłowo zagnieżdżać? W przeciwnym razie może ktoś początkujący nie zrozumie Twojego komentarza i skorzysta z powyższego formularza.
Rauni Lillemets
2
Zrozumiałem, że użytkownik2622016 miał na myśli, że musisz napisać tak: <ul><li><ul>...</ul></li> </ul>, aby najskrytszy <ul> .. </ ul > znajduje się również w bloku <li> .. </li>.
Rauni Lillemets
1
Chociaż nie mogę znaleźć tego wyraźnie zaznaczonego (a szukałem), jest to styl, który jest używany w dokumentacji Oracle . Również NetBeans narzeka na to. Z drugiej strony Intellij szczęśliwie dodaje </li>tagi
SeverityOne
28

Prawidłowy sposób jest następujący:

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

Chociaż JavaDoc zapożycza się z HTML, to nie jest HTML i powinieneś pomijać </li>tagi, tak jak powinieneś pomijać </p>tagi.

Severity One
źródło
1
Czy są jakieś odniesienia do pominięcia zamykających tagów?
friederbluemle
1
Tak, tutaj: oracle.com/technetwork/java/javase/documentation/… - chociaż jest to raczej niejawne niż jawne.
SeverityOne
Nie rozumiem, dlaczego ta odpowiedź nie ma więcej głosów pozytywnych.
John Smith
8

Lista zagnieżdżona powinna znajdować się we własnej <li>. <ul>nie jest prawidłowym elementem podrzędnym <ul>.

Twój przykład byłby taki:

<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
źródło
Twój kod prowadzi do listy z pustymi elementami. Chociaż jest prawidłowo zagnieżdżony w HTML, renderowany wynik jest brzydki.
naXa