------------恢復內容開始------------

簡述

使用 /** 開始 */結束的語法宣告，這是一個javadoc格式的註釋

/**後第一句就是概要性的文字，javadoc程式會把這些句子取出來，形成概要頁

類註釋

放在import之後，類定義之前

    package com.example.test;
import java.util.List;

/**
 * this is test myclass
 */
public class MyClass {
}

方法註釋

方法註釋在每一個方法之前
除了第一個描述之外可以加上如下標記
@param變數描述
對當前方法的param引數新增一個條目。描述可以佔據多行。但是所有@param標記要放在一起
@return描述
對當前方法的返回值進行描述，可以佔據多行
@throw
添加註釋，對可能丟擲的異常進行描述
 

    /**
     *  print class information
     * @param aa is param, as text
     * @return include all print text
     */
    public String printMyClass(int aa) {
        return "";
    }

域註釋

對公共域，通常指的是靜態變數進行建立文件

     /**
     * the HEAD is xxx
     */
    public static int HEAD = 1;

通用註釋

類文件的註釋：
在類文件開頭中體現
@author
產生一個author條目。使用多個@author標記，每個author對應一個作者
@version文字
產生version版本，對當前的版本進行任意描述
下面的註釋可以用在所有文件註釋中
@since文字
產生since條目。這裡的text針對引入特性的版本進行描述。例如  @since version 1.7.1
@deprecated文字
這個標記對類、方法或變數田間一個不再使用的註釋
通過#see和@link標記，使用超連結，連結到javadoc文件的相關部分或外部文件‘
@see引用
這個標記將在 "see also" 部分增加一個超連結。可以用於類中，也可以用域方法中
常用的
@see  com.horstmann.testjava#testclass(double)
建立連結到com.horstmann.testjava.testclass中。可以省略包名，甚至把包名和類名都省略，連結定位到當前的包或當前類
注意的是一定使用#標識類名和方法或變數
如果@see後面有一個<字元，代表套進行超連結，連結到任意URL
@see <a href="www.baidu.com>The Core</a>
如果@see後面有雙引號字元，文字會在 see also部分顯示
@see "Core java 2"
 

生成HTML的註釋

javadoc -d test com/example/test/MyClass.java
-d 後面接想文件生成的資料夾路徑
com/example/test/MyClass.java代表對哪個java檔案進行生成註釋處理，可以連續寫多個