Java 文檔注釋
java 文檔注釋
java 支持三種注釋方式。前兩種分別是 // 和 /* */，第三種被稱作說明注釋，它以 /** 開始，以 */結束。
我們可以使用 javadoc 工具軟件將程序中的說明注釋，輸出到 html 文件中。
1. javadoc 標簽
javadoc 工具軟件識別以下標簽：
| 標簽 | 描述 | 示例 |
|---|---|---|
| @author | 標識一個類的作者 | @author description |
| @deprecated | 指名一個過期的類或成員 | @deprecated description |
| {@docroot} | 指明當前文檔根目錄的路徑 | directory path |
| @exception | 標志一個類拋出的異常 | @exception exception-name explanation |
| {@inheritdoc} | 從直接父類繼承的注釋 | inherits a comment from the immediate surperclass. |
| {@link} | 插入一個到另一個主題的鏈接 | {@link name text} |
| {@linkplain} | 插入一個到另一個主題的鏈接，但是該鏈接顯示純文本字體 | inserts an in-line link to another topic. |
| @param | 說明一個方法的參數(shù) | @param parameter-name explanation |
| @return | 說明返回值類型 | @return explanation |
| @see | 指定一個到另一個主題的鏈接 | @see anchor |
| @serial | 說明一個序列化屬性 | @serial description |
| @serialdata | 說明通過writeobject( ) 和?writeexternal( )方法寫的數(shù)據(jù) | @serialdata description |
| @serialfield | 說明一個objectstreamfield組件 | @serialfield name type description |
| @since | 標記當引入一個特定的變化時 | @since release |
| @throws | 和 @exception標簽一樣. | the @throws tag has the same meaning as the @exception tag. |
| {@value} | 顯示常量的值，該常量必須是static屬性。 | displays the value of a constant, which must be a static field. |
| @version | 指定類的版本 | @version info |
2. 文檔注釋
在開始的 /** 之后，第一行或幾行是關于類、變量和方法的主要描述。
之后，你可以包含一個或多個各種各樣的 @ 標簽。每一個 @ 標簽必須在一個新行的開始或者在一行的開始緊跟星號(*).
多個相同類型的標簽應該放成一組。例如，如果你有三個 @see 標簽，可以將它們一個接一個的放在一起。
下面是一個類的說明注釋的范例：
/*** 這個類繪制一個條形圖 * @author yapf * @version 1.2 */
3. javadoc 輸出什么
javadoc 工具將你 java 程序的源代碼作為輸入，輸出一些包含你程序注釋的html文件。
每一個類的信息將在獨自的html文件里。javadoc 也可以輸出繼承的樹形結構和索引。
由于 javadoc 的實現(xiàn)不同，工作也可能不同，你需要檢查你的 java 開發(fā)系統(tǒng)的版本等細節(jié)，選擇合適的 javadoc 版本。
4. javadoc 輸出范例
下面是一個使用說明注釋的簡單范例。注意每一個注釋都在它描述的項目的前面。
在經(jīng)過 javadoc 處理之后，squarenum 類的注釋將在 squarenum.html 中找到。
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.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
$
Java基礎