在详细的java doc类描述中包含枚举

Question

我用两步简短描述和该描述的开发版本描述了一些使用JavaDoc的类：

/*
 *
 * This class will be used to do things.
 * <p>
 *    Here I am expanding the short description  ...
 * </p>
 * ...
 */
 Class myClass 
 {
     ...
     ...
     ...
 }

我想知道是否可以在详细说明中包含列表和枚举，因此结果应该是这样的：

/*
 *
 * This class will be used to do things.
 * <p>
 *    Here I am expanding the short description  ...
 *    * List element 1
 *    * List element 2
 * </p>
 * ...
 */
 Class myClass 
 {
     ...
     ...
     ...
 }

但是在JavaDoc的HTML输出中生成枚举和/或列表。 我应该在JavaDoc评论中使用<ul>和<ol>等HTML元素吗？

Answer 1

是的，HTML元素如

 *  <ul>
 *    <li>Item1</li>
 *    <li>Item2</li>
 *  </ul>

在javadoc中完全没问题。有关更多示例，请查看标准Java API类。

Answer 2

我测试了我的JavaDoc注释，发现HTML令牌包含在生成的文档中：

/**
 * Class intended ....................
 * <p>
 *     Each object ...................
 *     <ul>
 *        <li>Item1</li>
 *        <li>Item2</li>
 *     </ul>
 * </p>
 * @author Pablo.Francisco.Pérez.Hidalgo
 * @since 2013-03-22
 */