it-swarm.dev

Wie erstelle ich in Javadoc mehrere Einzugsebenen?

Angenommen, Sie möchten im Rahmen der Dokumentation Ihres Codes (Javadoc) angeben, dass die Beziehungen zwischen Elementen durch tiefe Einrückungen hergestellt werden.

Wie kann ich eine verschachtelte Liste erstellen als:

  • irgendein Element
    • ein anderes Element
      • noch ein anderes Element
70
JAM
<ul>
  <li>Element</li>
  <ul>
     <li>Subelement...</li>

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

Update: Weil es auftauchte, habe ich es versucht

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

und bekomme

  • einer
    • ein Punkt eins

Ich stimme zu, dass eine korrekte Verschachtelung besser ist.

110
Charlie Martin

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

JavaDoc leiht zwar aus HTML, ist aber kein HTML-Code, und Sie sollten die Tags </li> Weglassen, genauso wie Sie die Tags </p> Weglassen sollten.

12
SeverityOne

Die verschachtelte Liste sollte sich in einem eigenen <li> Befinden. <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>
6
Drew Noakes