Wie erstelle ich in Javadoc mehrere Einrückungsstufen?

85

Angenommen, Sie möchten im Rahmen der Dokumentation Ihres Codes (Javadoc) angeben, dass die Beziehungen zwischen Elementen mit einem tiefen Einzug versehen sind.

Wie kann ich eine verschachtelte Liste erstellen als:

  • irgendein Element
    • ein anderes Element
      • noch ein anderes Element
James Raitsev
quelle

Antworten:

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

Sie können HTML in Javadoc-Kommentaren ziemlich frei verwenden.

Update: Weil es aufgetaucht ist, habe ich es versucht

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

und bekomme

  • einer
    • ein Punkt eins

Ich bin damit einverstanden, dass eine richtige Verschachtelung besser ist.

Charlie Martin
quelle
2
Ich würde sagen, verschachteltes <ul> muss sich in einem <li> -Element befinden. Zum Vergleich siehe w3.org/wiki/HTML_lists#Nesting_lists
user2622016
Sie können das sagen, aber wenn Sie es versuchen, sagt das etwas anderes.
Charlie Martin
1
@Charlie Anstatt zu sagen "Ich stimme zu, dass richtiges Verschachteln besser ist.", Könnten Sie vielleicht ein Beispiel schreiben, das zeigt, wie man richtig verschachtelt? Andernfalls versteht möglicherweise ein Anfänger Ihren Kommentar nicht und verwendet das oben genannte Formular.
Rauni Lillemets
2
Ich habe verstanden, dass user2622016 bedeutete, dass Sie wie folgt schreiben müssen: <ul> <ul> <li> </ ul> </ ul>, damit das innerste <ul> .. </ ul > befindet sich auch in einem <li> .. </ li> -Block.
Rauni Lillemets
1
Obwohl ich es nicht explizit finden kann (und ich habe es mir angesehen), ist es der Stil, der in der Dokumentation von Oracle verwendet wird . Auch NetBeans beschwert sich darüber. Intellij hingegen fügt die </li>Tags gerne hinzu
SeverityOne
26

Der richtige Weg ist wie folgt:

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

Obwohl JavaDoc aus HTML entlehnt ist, ist es kein HTML, und Sie sollten die </li>Tags weglassen , genauso wie Sie </p>Tags weglassen sollten .

SeverityOne
quelle
1
Irgendwelche Referenzen für das Weglassen der schließenden Tags?
Friederbluemle
1
Ja, hier: oracle.com/technetwork/java/javase/documentation/… - obwohl es eher implizit als explizit ist.
SeverityOne
Verstehe nicht, warum diese Antwort nicht mehr positive Stimmen hat.
John Smith
8

Die verschachtelte Liste sollte innerhalb ihrer eigenen sein <li>. <ul>ist kein gültiges untergeordnetes Element von <ul>.

Ihr Beispiel wäre also:

<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
quelle
Ihr Code führt zu einer Liste mit leeren Elementen. Obwohl es richtig in HTML verschachtelt ist, ist das gerenderte Ergebnis hässlich.
NaXa