Question

javadoc 将 HTML 命令传递给最终生成的 HTML 文档。这便使我们能够充分利用 HTML 的巨大威力。当然，我们的最终动机是格式化代码，不是为了哗众取宠。下面列出一个例子：

/**

* <pre>

* System.out.println(new Date());

* </pre>

*/

亦可象在其他 Web 文档里那样运用 HTML，对普通文本进行格式化，使其更具条理、更加美观：

/**

* 您<em>甚至</em>可以插入一个列表：

* <ol>

* <li> 项目一

* <li> 项目二

* <li> 项目三

* </ol>

*/

注意在文档注释中，位于一行最开头的星号会被 javadoc 丢弃。同时丢弃的还有前导空格。javadoc 会对所有内容进行格式化，使其与标准的文档外观相符。不要将<h1>或<hr>这样的标题当作嵌入 HTML 使用，因为 javadoc 会插入自己的标题，我们给出的标题会与之冲撞。

所有类型的注释文档——类、变量和方法——都支持嵌入 HTML。