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


Answers:


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

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

更新:因为出现了,所以我尝试了

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

并得到

    • 一分一

我同意适当的嵌套会更好。


2
我想说嵌套<ul>必须在某些<li>元素内,以进行比较,请参阅w3.org/wiki/HTML_lists#Nesting_lists
user2622016 2013年

您可以这么说,但是尝试它却有所不同。
查理·马丁

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

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
By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.