文件註釋

文件註釋負責描述類、介面、方法、構造器、成員欄位。可以被JDK提供的工具 javadoc 所解析，自動生成一套以網頁檔案形式體現的該程式說明文件的註釋。

注意：文件註釋必須寫在類、介面、方法、構造器、成員欄位前面，寫在其他位置無效。

格式：

/**
* 對於類、介面和方法的描述
*  @ 標籤
*  @ 標籤
* 
*/

對於類、介面和方法的描述部分：
不僅可以用文字還可以使用html標籤。如：<p>xxxxx</p>

標記部分：
格式如： @param parameter-name explanation

常用的標籤如下：

使用javadoc生成文件:
cmd命令： javadoc 檔名.java

生成的網頁中 index.html 就是文件的首頁。

例項演示：

程式碼示例：

/**
 * 一個示例類
 * 測試實現數字運算
 * @author AEven
 * @version 1.10
 * */

public class Demo01 {
    /**
     * 求取兩數之和
     * @param a 用來表示一個加數。
     * @param b 用來表示一個加數。
     * @return 返回兩數之和。
     * */
    public int add(int a,int b) {
        return a+b;
    }
    /**
     * 求取兩數之差
     * @param a 用來表示減數。
     * @param b 用來表示被減數。
     * @return 返回兩數之差。
     * */
    public int sub(int a,int b) {
        return a-b;
    }
    /**
     * 求取兩數最大值
     * @param a 用來表示一個要對比的數
     * @param b 用來表示一個要對比的數。
     * @return 返回兩數最大值。
     * */
    public int max(int a,int b) {
        if(a>b) {
            return a;
        }
        return b;
    }

}

在命令提示符下執行javadoc命令

在當前目錄下進入index.html

以上為java文件註釋的應用及javadoc的簡單用法。