如题所述
javadoc将HTML命令嵌入到它所生成的HTML文档中。这使你能够充分利用HTML的功能。当然,其主要目的还是为了对代码进行格式化。下面列出一个例子:
/***<pre>*System.out.println(newDate());*</pre>*/
你也可以像在其他Web文档中那样运用HTML,对普通文本按照你自己所描述的进行格式化。
/***Youcan<em>even</em>insertalist:*<ol>*<li>Itemone*<li>Itemtwo*<li>Itemthree*</ol>*/
注意,在文档注释中,位于每一行开头的星号和前导空格都会被javadoc丢弃。Javadoc会对所有内容重新格式化,使其与标准的文档外观一致。不要在嵌入式HTML中使用标题标签,例如:<h1>或<hr>,因为javadoc会插入自己的标题,而你的标题可能会对它造成干扰。
所有类型的注释文档——类、变量和方法——都支持嵌入式HTML。
温馨提示:答案为网友推荐,仅供参考