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。