Javadocで複数レベルのインデントを作成するにはどうすればよいですか?


88

コード(Javadoc)の文書化の一環として、深いインデントを使用して要素間の関係を示したいとします。

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

  • いくつかの要素
    • 他の要素
      • まだいくつかの他の要素

回答:


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

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

更新:それが出てきたので、私は試しました

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

取得します

  • 1
    • ワンポイントワン

適切なネストの方が良いことに同意します。


2
私は、ネストされた<UL>比較参照のために、いくつかの<LI>要素内である必要がありますでしょうねw3.org/wiki/HTML_lists#Nesting_lists
user2622016

あなたはそれを言うことができます、しかしそれを試みることは何か違うことを言います。
チャーリーマーティン

1
@Charlie「適切なネストの方が良いことに同意します。」と言う代わりに、適切にネストする方法を示す例を書くことができますか?そうしないと、初心者があなたのコメントを理解できず、上記のフォームを使用する可能性があります。
Rauni Lillemets 2014

2
user2622016は、次のように記述する必要があることを理解しました:<ul> <li> <ul> ... </ ul> </ li> </ ul>、つまり最も内側の<ul> .. </ ul >も<li> .. </ li>ブロック内にあります。
Rauni Lillemets 2014

1
明示的に記載されていることはわかりませんが(実際に調べました)、Oracleのドキュメントで使用されているスタイルです。また、NetBeansはそれについて不平を言っています。一方、Intellijは喜んで</li>タグを追加します
SeverityOne

28

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

/**
 * <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>必要があります。


1
終了タグの省略に関する参照はありますか?
friederbluemle 2018年

1
はい、ここにあります:oracle.com/technetwork/java/javase/documentation/…-明示的ではなく暗黙的ですが。
SeverityOne

この回答に賛成票がない理由がわかりません。
ジョンスミス

8

ネストされたリストは、それ自体の中にある必要があります<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>

コードの結果、空のアイテムを含むリストが作成されます。HTMLに適切にネストされていますが、レンダリング結果は見苦しいものです。
naXa 2018
弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.