java 文檔注釋

java 支持三種注釋方式。前兩種分別是 // 和 /* */，第三種被稱作說明注釋，它以 /** 開始，以 */結(jié)束。

我們可以使用 javadoc 工具軟件將程序中的說明注釋，輸出到 html 文件中。

1. javadoc 標(biāo)簽

javadoc 工具軟件識(shí)別以下標(biāo)簽：

2. 文檔注釋

在開始的 /** 之后，第一行或幾行是關(guān)于類、變量和方法的主要描述。

之后，你可以包含一個(gè)或多個(gè)各種各樣的 @ 標(biāo)簽。每一個(gè) @ 標(biāo)簽必須在一個(gè)新行的開始或者在一行的開始緊跟星號(hào)(*).

多個(gè)相同類型的標(biāo)簽應(yīng)該放成一組。例如，如果你有三個(gè) @see 標(biāo)簽，可以將它們一個(gè)接一個(gè)的放在一起。

下面是一個(gè)類的說明注釋的范例：

/*** 這個(gè)類繪制一個(gè)條形圖
* @author yapf
* @version 1.2
*/

3. javadoc 輸出什么

javadoc 工具將你 java 程序的源代碼作為輸入，輸出一些包含你程序注釋的html文件。

每一個(gè)類的信息將在獨(dú)自的html文件里。javadoc 也可以輸出繼承的樹形結(jié)構(gòu)和索引。

由于 javadoc 的實(shí)現(xiàn)不同，工作也可能不同，你需要檢查你的 java 開發(fā)系統(tǒng)的版本等細(xì)節(jié)，選擇合適的 javadoc 版本。

4. javadoc 輸出范例

下面是一個(gè)使用說明注釋的簡單范例。注意每一個(gè)注釋都在它描述的項(xiàng)目的前面。

在經(jīng)過 javadoc 處理之后，squarenum 類的注釋將在 squarenum.html 中找到。

import java.io.*;

/**
* 這個(gè)類演示了文檔注釋
* @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.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
$