如何在Javadoc中创建多个级别的缩进?

Jam*_*sev 71 documentation javadoc indentation nested-lists

假设,作为记录代码(Javadoc)的一部分,您希望使用深度缩进来指示元素之间的关系.

如何创建嵌套列表:

  • 一些元素
    • 其他一些因素
      • 还有一些其他因素

Cha*_*tin 113

<ul>
  <li>Element</li>
  <ul>
     <li>Subelement...</li>
Run Code Online (Sandbox Code Playgroud)

您可以在javadoc注释中自由使用HTML.

更新:因为它出现了,我试过了

<ul>
    <li>one</li>
    <ul>
        <li>one point one</li>
    </ul>   
</ul>
Run Code Online (Sandbox Code Playgroud)

得到

    • 一点一点

我同意适当的嵌套更好.

  • 我想说嵌套的<ul>必须在一些<li>元素中,为了比较,请参阅http://www.w3.org/wiki/HTML_lists#Nesting_lists (2认同)
  • @Charlie 而不是说“我同意适当的嵌套更好。”,也许你可以写一个例子来说明如何正确嵌套?否则,也许有些初学者不会理解您的评论并使用上述表格。 (2认同)
  • 我知道 user2622016 意味着你必须这样写:&lt;ul&gt;&lt;li&gt;&lt;ul&gt;...&lt;/ul&gt;&lt;/li&gt;&lt;/ul&gt;,这样最里面的 &lt;ul&gt;..&lt;/ul &gt; 也在 &lt;li&gt;..&lt;/li&gt; 块内。 (2认同)
  • 不过,需要做的一件事是删除 `&lt;/li&gt;` 标签。他们不应该在那里。JavaDoc 不是 HTML,尽管它借鉴了 HTML。`&lt;/p&gt;` 标签也是如此,你不应该在 JavaDoc 中使用它。 (2认同)
  • 虽然我找不到它明确说明(我确实看过),但它是 [Oracle 文档](http://www.oracle.com/technetwork/java/javase/tech/index-137868.html) 中使用的样式. 此外,NetBeans 也抱怨它。另一方面,Intellij 高兴地添加了`&lt;/li&gt;` 标签 (2认同)

Sev*_*One 14

正确的方法如下:

/**
 * <ul>
 *   <li>some element
 *   <li><ul>
 *     <li>some other element
 *     <li><ul>
 *       <li>yet some other element
 *     </ul>
 *   </ul>
 * </ul>
 */
Run Code Online (Sandbox Code Playgroud)

尽管JavaDoc是从HTML借用的,但它不是HTML,因此您应该</li>像省略</p>标记一样省略标记。

  • 关于省略结束标签的任何参考? (2认同)
  • 是的,在这里:http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html#examples - 尽管它是隐式的而不是显式的。 (2认同)

Dre*_*kes 7

嵌套列表应该在它自己的内部<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>
Run Code Online (Sandbox Code Playgroud)