Java 文檔註釋

概述

Java只有3種註釋方式。

• //,單行註釋

• /* */,塊註釋

• 說明註釋，@author,@version等

說明註釋容許你在程序中嵌入關於程序的信息。你可使用javadoc工具軟件來生成信息，並輸出到HTML文件中。

Javadoc 標籤

javadoc工具軟件識別如下標籤

標籤	描述
@author	標示一個類的做者
@deprecated	標識一個過時的類或成員
{@docRoot}	指明當前文檔跟目錄的路徑
@exception	指明一個類拋出的異常
@throws	和@exception同樣
{@inheritDoc}	從直接父類繼承的註釋
{@link}	插入一個到另外一個主題的連接
{@linkplain}	插入一個到另外一個主題的連接，但該連接顯示純文本字體
@param	說明一個方法的參數
@return	說明返回值類型
@see	指定一個到另外一個主題的連接
@serial	說明一個序列化屬性
@serialData	說明經過 writeObject() 和 writeExternal() 方法寫的數據
@serialField	說明一個ObjectStreamField組件
@since	標記當引入一個特定的變化時
{@value}	顯示常亮的值，必須是static屬性
@version	指定類的版本號

文檔註釋

在開始的/**以後，第一行或幾行是關於類、變量和方法的主要描述。

以後，你能夠包一個或多個各類各樣的@標籤。每個@標籤必須在一個新行的開始。

多個相同類型的標籤應該放成一組。例如，若是你有三個@see標籤，能夠將它們一個接一個的放在一塊兒。

/** 
* 類描述
* @author panda
* @version 1.2
*/
...

Javadoc 輸出

Javadoc 工具將你Java程序的源代碼做爲輸入，輸出一些包含你程序註釋的HTML文件。

每個類的信息將在獨自的HTML文件裏。Javadoc也能夠輸出繼承的樹形結構和索引。

因爲Javadoc的實現不一樣，工做也可能不一樣，你須要檢查你的Java開發系統的版本等細節，選擇合適的Javadoc版本。

實例

package com.coder4j.jse.javadoc;

import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStreamReader;

/**
 * 輸入一個數，輸出其平方數。
 * 
 * @author panda
 * @version 1.2
 */
public class SquareNum {
    
    /**
     * 輸出平方值。
     * 
     * @param num
     *            待求平方數
     * @return 平方值
     */
    public double square(double num) {
        return num * num;
    }

    /**
     * 用戶輸入一個數
     * 
     * @return 返回用戶輸入的數
     * @exception IOException
     *                可能拋出的異常
     * @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();
    }

    /**
     * 入口主函數
     * 
     * @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("請輸入一個數: ");
        val = ob.getNumber();
        val = ob.square(val);
        System.out.println("平方值是: " + val);
    }
}

我在eclipse裏寫了這個類，右鍵export，選擇Java/javadoc 而後按提示確認，控制檯輸出：

正在加載程序包com.coder4j.jse.javadoc的源文件...
正在構造 Javadoc 信息...
標準 Doclet 版本 1.7.0_75
正在構建全部程序包和類的樹...
正在生成/Users/panda/Documents/lunaspace/code4j/doc/com/coder4j/jse/javadoc/SquareNum.html...
/Users/panda/Documents/lunaspace/code4j/src/com/coder4j/jse/javadoc/SquareNum.java:52: 警告 - 不能在返回類型爲空的方法中使用 @return 標記。
正在生成/Users/panda/Documents/lunaspace/code4j/doc/com/coder4j/jse/javadoc/package-frame.html...
正在生成/Users/panda/Documents/lunaspace/code4j/doc/com/coder4j/jse/javadoc/package-summary.html...
正在生成/Users/panda/Documents/lunaspace/code4j/doc/com/coder4j/jse/javadoc/package-tree.html...
正在生成/Users/panda/Documents/lunaspace/code4j/doc/constant-values.html...
正在生成/Users/panda/Documents/lunaspace/code4j/doc/com/coder4j/jse/javadoc/class-use/SquareNum.html...
正在生成/Users/panda/Documents/lunaspace/code4j/doc/com/coder4j/jse/javadoc/package-use.html...
正在構建全部程序包和類的索引...
正在生成/Users/panda/Documents/lunaspace/code4j/doc/overview-tree.html...
正在生成/Users/panda/Documents/lunaspace/code4j/doc/index-files/index-1.html...
正在生成/Users/panda/Documents/lunaspace/code4j/doc/index-files/index-2.html...
正在生成/Users/panda/Documents/lunaspace/code4j/doc/index-files/index-3.html...
正在生成/Users/panda/Documents/lunaspace/code4j/doc/index-files/index-4.html...
正在生成/Users/panda/Documents/lunaspace/code4j/doc/deprecated-list.html...
正在構建全部類的索引...
正在生成/Users/panda/Documents/lunaspace/code4j/doc/allclasses-frame.html...
正在生成/Users/panda/Documents/lunaspace/code4j/doc/allclasses-noframe.html...
正在生成/Users/panda/Documents/lunaspace/code4j/doc/index.html...
正在生成/Users/panda/Documents/lunaspace/code4j/doc/help-doc.html...
1 個警告

默認在當前項目下新增doc目錄

doc/
|--com
|--index-files
|--resources
|--allclasses-frame.html
|--allclasses-noframe.html
|--constant-values.html
|--deprecated-list.html
|--help-doc.html
|--index.html
|--overview-tree.html
|--package-list
|--stylesheet.css

能夠直接訪問index.html,你會看到相似這樣的頁面。

不一樣的Javadoc版本可能稍有不一樣喲。

參考資料

• Java 文檔註釋