所有javadoc命令都只能出現於“/**”注釋中。但和平常一樣,注釋結束於一個“*/”。主要通過兩種方式來使用javadoc:嵌入的HTML,或使用“文檔標記”。其中,“文檔標記”(Doc tags)是一些以“@”開頭的命令,置於注釋行的起始處(但前導的“*”會被忽略)。
有三種類型的注釋文檔,它們對應於位於注釋後面的元素:類、變量或者方法。也就是說,一個類注釋正好位於一個類定義之前;變量注釋正好位於變量定義之前;而一個方法定義正好位於一個方法定義的前面。如下面這個簡單的例子所示:
/** 一個類注釋 */
public class docTest {
/** 一個變量注釋 */
public int i;
/** 一個方法注釋 */
public void f() {}
}
注意javadoc只能為public(公共)和protected(受保護)成員處理注釋文檔。“private”(私有)和“友好”(詳見5章)成員的注釋會被忽略,我們看不到任何輸出(也可以用-private標記包括private成員)。這樣做是有道理的,因為只有public和protected成員才可在文件之外使用,這是客戶程序員的希望。然而,所有類注釋都會包含到輸出結果裡。
上述代碼的輸出是一個HTML文件,它與其他Java文檔具有相同的標准格式。因此,用戶會非常熟悉這種格式,可在您設計的類中方便地“漫游”。設計程序時,請務必考慮輸入上述代碼,用javadoc處理一下,觀看最終HTML文件的效果如何。