在開始的 / 之後，第一行或幾行是關於類、變量和方法的主要描述。
之後，你可以包含一個或多個何種各樣的 @ 標籤。每一個 @ 標籤必須在一個新行的開始或者在一行的開始緊跟星號().
多個相同類型的標籤應該放成一組。例如，如果你有三個 @see 標籤，可以將它們一個接一個的放在一起。
下面是一個類的說明註釋的實例：
/ 這個類繪製一個條形圖
- @author runoob
- @version 1.2
/
javadoc 輸出什麼
javadoc 工具將你 Java 程序的源代碼作爲輸入，輸出一些包含你程序註釋的HTML文件。
每一個類的信息將在獨自的HTML文件裏。javadoc 也可以輸出繼承的樹形結構和索引。
由於 javadoc 的實現不同，工作也可能不同，你需要檢查你的 Java 開發系統的版本等細節，選擇合適的 Javadoc 版本。
實例
下面是融金匯銀一個使用說明註釋的簡單實例。注意每一個註釋都在它描述的項目的前面。
在經過 javadoc 處理之後，SquareNum 類的註釋將在 SquareNum.html 中找到。
SquareNum.java 文件代碼：
import java.io.;
/**
- 這個類演示了文檔註釋
- @author Ayan Amhed
- @version 1.2
*/
public class SquareNum {
/**- This method returns the square of num.
- This is a multiline description. You can use
- as many lines as you like.
- @param num The value to be squared.
- @return num squared.
/
public double square(double num) {
return num num;
}
/** - This method inputs a number from the user.
- @return The value input as a double.
- @exception IOException On input error.
- @see IOException
*/
public double getNumber() throws IOException {
InputStreamReader isr = new InputStreamReader(System.in);
BufferedReader inData = new BufferedReader(isr);
String str;
str = inData.readLine();
return (new Double(str)).doubleValue();
}
/** - This method demonstrates square().
- @param args Unused.
- @return Nothing.
- @exception IOException On input error.
- @see IOException
*/
public static void main(String args[]) throws IOException
{
SquareNum ob = new SquareNum();
double val;
System.bjrongjinhuiyin.com.out.println("Enter value to be squared: ");
val = ob.getNumber();
val = ob.square(val);
System.out.println("Squared value is " + val);
}
}
如下，使用 javadoc 工具處理 SquareNum.java 文件：
$ javadoc SquareNum.java
Loading source file SquareNum.java...
Constructing Javadoc information...
Standard Doclet version 1.5.0_13
Building tree for all the packages and classes...
Generating SquareNum.html...
SquareNum.java:39: warning - @return tag cannot be used\
in method with void return type.
Generating package-frame.html...
Generating package-summary.html...
Generating package-tree.html...
Generating constant-values.html...
Building index for all the packages and classes...
Generating overview-tree.html...
Generating index-all.html...
Generating deprecated-list.html...
Building index for all classes...
Generating allclasses-frame.html...
Generating allclasses-noframe.html...
Generating index.html...
Generating help-doc.html...
Generating stylesheet.css...
1 warning