/**

?* Title:Persions類<br>

?* Description:通過Persons類來說明Java中的文檔注釋

?* Company：Zl

?* @author zl

?* @version 1.0

?*

?*/

public class Persons {

public String name;

/**

?* 這是Persions類的構造方法

?* @param name Persions的名字

?*/

public Persons(String name) {

//執行語句

this.name = name;

}

?

/**

?* 這是read()方法的說明

?* @param bookName 讀的書的名字

?* @param time 讀書需要的時間

?* @return 讀的書的數量

?*/

public int read(String bookName, int time){

?

return time;

}

}

@author

用于對類的說明 ,表示這個程序 的作者

@version

用于對類的說明,表示 這個程序的開發版本號

@param

用于對方法的說明,表示 方法定義 的參數以及參數 對應的說明.

@return

用于對方法的說明,表示方法的返回值代表的意義.

Javadoc -d . -version -author Persons.java

-d

用來指定 輸出文檔存放的目錄

.

表示 當前的目錄

-version

用來指定輸出文檔中需包含版本信息

-author

用來指定輸出文檔中需包含作者信息