web-dev-qa-db-ja.com

Javadocで複数レベルのインデントを作成する方法は？

コード（Javadoc）のドキュメント化の一環として、要素間の関係が深いインデントを使用していることを示したいとします。

ネストされたリストを次のように作成するにはどうすればよいですか？

  • いくつかの要素
    • 他の要素
      • まだ他の要素
documentationjavadocindentationnested-lists
70
JAM
<ul>
  <li>Element</li>
  <ul>
     <li>Subelement...</li>

Javadocコメント内でHTMLをかなり自由に使用できます。

更新：それが現れたので、私は試しました

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

そして得る

  • 1
    • ワンポイントワン

適切なネスティングの方が良いことに同意します。

110
Charlie Martin

正しい方法は次のとおりです。

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

JavaDocはHTMLから借用していますが、HTMLではありません。</li>タグを省略する必要があるのと同様に、</p>タグを省略する必要があります。

12
SeverityOne

ネストされたリストは、独自の<li>内にある必要があります。 <ul>は<ul>の有効な子要素ではありません。

あなたの例は次のようになります：

<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