使用文檔注釋（javadoc）

　相信作為Java程序猿,幾乎每個人都使用過javac,Java這樣的命令吧。想想我們平時使用的Java幫助文檔（API）,感覺挺好用的,其實它就是使用Java中的命令javadoc做成的.下面簡單介紹一下這個命令是怎么使用的：

　首先Java中用三種注釋方式,要想使用javadoc生成文檔並且將注釋信息也添加進文檔里面,就要是用這種方式:

/**
  *
  */

　其次就是注釋信息應該放置的位置。1.對類的注釋放在類申明之前;2.對方法的注釋放在方法申明之前;下面舉一個簡單的例子:

package com.review.chapter3;

/**
 * ClassName: UseJavadoc<br>
 * Description: 通過UseJavadoc類說明Java中文檔注釋<br>
 * Company: zhouxy
 * @author zhouxy
 * @version 20140829
 *
 */
public class UseJavadoc {
    public String name;
    
    /**
     * 這是UseJavadoc類的構造函數
     * @param name 參數
     */
    public UseJavadoc(String name){
        this.name = name;
    }
    
    
    /**
     * 這是getAll方法的說明
     * @param number 數量
     * @return 數量
     */
    public int getAll(int number){
        
        return number;
    }
}

　在上面的代碼中有的注釋后面加上了<br>標簽,有的沒有,是因為@符號自帶一個換行符,所以使用@就不必添加<br>標簽了.

　下面就是使用javadoc命令來生成了。首先使用快捷鍵win+R,在對話框里面鍵入cmd,切換到改文件保存的目錄之下,然后又一下三種方式(假設你想將生成的HTML文檔保存在docDirectory目錄下):

　1.如果你要生成的是一個包:javadoc -d docDirectory -version -author nameOfPackage

　2.如果你要生成的是多個包:javadoc -d docDirectory -version -author nameOfPackage1 nameOfPackage2.....

　3.如果文件在默認包中:javadoc -d docDirectory -version - author *.java

　如果省略了 -d docDirectory 那么生成的HTML文檔會保存在當前目錄下,這樣會帶來混亂,不提倡這樣做。

　-version -author表示要求在說明文檔中加入版本信息和作者信息。nameOfPackage 表示java類所在的包名.