documentation - 如何在 Javadoc 中创建多级缩进？

Question

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

如何创建嵌套列表：

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

Answer 1

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

您可以在 javadoc 注释中非常自由地使用 HTML。

更新：因为它出现了，我试过了

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

并得到

• 一
• 一点一

我同意适当的嵌套更好。

Answer 2

正确的方法如下：

/**
 * <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>标签一样。

Answer 3

嵌套列表应该在它自己的<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>