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

【问题标题】：Include enumeration within detailed java doc class description在详细的 java doc 类描述中包含枚举
【发布时间】：2014-03-22 13:27:32
【问题描述】：

我正在使用 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 cmets 中使用 HTML 元素，例如 <ul> 和 <ol>？

【问题讨论】：

标签： java documentation javadoc

【解决方案1】：

是的，像

这样的 HTML 元素

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

在 javadoc 中完全没问题。查看标准 Java API 类以获取更多示例。

【讨论】：

【解决方案2】：

我测试了我的 JavaDoc cmets，发现生成的文档中包含 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
 */

【讨论】：