如何在 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，你应该省略标签，就像你应该省略

一样; 标签。

Answer 3

嵌套列表应位于其自己的

内。

不是
的有效子元素。

所以你的例子是：

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

Answer 4

在 javdoc 中保持缩进的另一种更简单快速的方法

...

简而言之，它按照编写的方式呈现行格式。
在使用之前最好咨询您的团队，以防万一。

例如，这

/**
* <pre>
* - some element
*    - some other element
*       - yet some other element
* </pre>
*/

将呈现如下：

 - some element
    - some other element
       - yet some other element

优点：

• 比多级 HTML 嵌套更具可读性
• 简单、
• 快速键入
• 通过 tab 保持行缩进，并且
• 基本上
• 所见即所得的空格可用于通过使用 < 来很好地呈现代码块code>{@code ...}

缺点：

• 软换行会调整为

  ...

  块内最长的行，因此需要手动换行