Day6-16.Embedded HTML

嵌入式HTML

javadoc通过生成的HTML文档传送HTML命令，这使你能够充分利用HTML。

当然，其主要目的还是为了对代码进行格式化，例如：

/:: object /Documentation2.java

/**

*<pre>

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

*</pre>

*/

///:~

也可以像在其他Web文档中那样运用HTML，对普通文本按照你自己所描述的进行格式化：

//: object/Documentation3.java

/**

* You can <em>even</em> insert a list:

*<ol>

*<li> Item one

*<li>Item two

*<li>Item three

*</ol>

*/

///:~

注意，在文档注释中，位于每一行开头的星号和前导空格都会被javadoc丢弃。

javadoc会对所有内容重新格式化，使其与标准的文档外观一致。

不要在嵌入式HTML中使用标题标签，例如<h1>或<hr>,因为javadoc会插入自己的标题，而你的标题可能同它们发生冲突。

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