朋友你好，用使用 javadoc 標(biāo)記可以做到。具體說(shuō)明如下：：

javadoc 標(biāo)記是插入文檔注釋中的特殊標(biāo)記，它們用于標(biāo)識(shí)代碼中的特殊引用。javadoc 標(biāo)記由“@”及其后所跟的標(biāo)記類型和專用注釋引用組成。記住了，三個(gè)部分——@、標(biāo)記類型、專用注釋引用。

不過(guò)我寧愿把它分成兩部分：@ 和標(biāo)記類型、專用注釋引用。雖然 @ 和 標(biāo)記類型之間有時(shí)可以用空格符分隔，但是我寧愿始終將它們緊挨著寫，以減少出錯(cuò)機(jī)會(huì)。

javadoc 標(biāo)記有如下一些：

標(biāo)記 用于 作用

@author 對(duì)類的說(shuō)明 標(biāo)明開(kāi)發(fā)該類模塊的作者

@version 對(duì)類的說(shuō)明 標(biāo)明該類模塊的版本

@see 對(duì)類、屬性、方法的說(shuō)明 參考轉(zhuǎn)向，也就是相關(guān)主題

@param 對(duì)方法的說(shuō)明 對(duì)方法中某參數(shù)的說(shuō)明

@return 對(duì)方法的說(shuō)明 對(duì)方法返回值的說(shuō)明

@exception 對(duì)方法的說(shuō)明 對(duì)方法可能拋出的異常進(jìn)行說(shuō)明

下面詳細(xì)說(shuō)明各標(biāo)記。

1。 @see 的使用

@see 的句法有三種：

@see 類名

@see #方法名或?qū)傩悦?/p>

@see 類名#方法名或?qū)傩悦?/p>

類名，可以根據(jù)需要只寫出類名 (如 String) 或者寫出類全名 (如 ng。

String)。那么什么時(shí)候只需要寫出類名，什么時(shí)候需要寫出類全名呢？

如果 java 源文件中的 import 語(yǔ)句包含了的類，可以只寫出類名，如果沒(méi)有包含，則需要寫出類全名。 ng 也已經(jīng)默認(rèn)被包含了。這和 javac 編譯 java 源文件時(shí)的規(guī)定一樣，所以可以簡(jiǎn)單的用 javac 編譯來(lái)判斷，源程序中 javac 能找到的類，javadoc 也一定能找到；javac 找不到的類，javadoc 也找不到，這就需要使用類全名了。

方法名或者屬性名，如果是屬性名，則只需要寫出屬性名即可；如果是方法名，則需要寫出方法名以及參數(shù)類型，沒(méi)有參數(shù)的方法，需要寫出一對(duì)括號(hào)。如

成員類型 成員名稱及參數(shù) @see 句法

屬性 number @see number

屬性 count @see count

方法 count() @see count()

方法 show(boolean b) @see show(boolean)

方法 main(String[] args) @see main(String[])

有時(shí)也可以偷懶：假如上例中，沒(méi)有 count 這一屬性，那么參考方法 count() 就可以簡(jiǎn)寫成 @see count。

不過(guò)，為了安全起見(jiàn)，還是寫全 @see count() 比較好。

@see 的第二個(gè)句法和第三個(gè)句法都是轉(zhuǎn)向方法或者屬性的參考，它們有什么區(qū)別呢？

第二個(gè)句法中沒(méi)有指出類名，則默認(rèn)為當(dāng)前類。所以它定義的參考，都轉(zhuǎn)向本類中的屬性或者方法。

而第三個(gè)句法中指出了類名，則還可以轉(zhuǎn)向其它類的屬性或者方法。

關(guān)于 @see 標(biāo)記，我們舉個(gè)例說(shuō)明。由于 @see 在對(duì)類說(shuō)明、對(duì)屬性說(shuō)明、對(duì)方法說(shuō)明時(shí)用法都一樣，所以這里只以對(duì)類說(shuō)明為例。

/**

* @see String

* @see ng。

StringBuffer

* @see #str

* @see #str()

* @see #main(String[])

* @see Object#toString()

*/

public class TestJavaDoc {

}

生成的文檔的相關(guān)部分如下圖：

String 和 StringBuffer 都是在 ng 包中，由于這個(gè)包是默認(rèn)導(dǎo)入了的，所以這兩個(gè)類可以直接寫類名，也可以寫類全名。

str、str() 為同名屬性和方法，所以方法名需要用 () 區(qū)分。main 是帶參數(shù)的方法，所以在 () 中指明了參數(shù)類型。toString() 雖然在本類中也有 (從 Object 繼承的)，但我們是想?yún)⒖?Object 類的 toString() 方法，所以使用了 Object#toString()。

奇怪的是，為什么其中只有 str、str() 和 main(String[]) 變成了鏈接呢？那是因?yàn)榫幾g時(shí)沒(méi)有把 ng 包或者 Stirng、StringBuffer、Object 三個(gè)類的源文件一起加入編譯，所以，生成的文檔沒(méi)有關(guān)于那三個(gè)類的信息，也就不可以建立鏈接了。

后面講解 javadoc 編譯命令的時(shí)候還會(huì)詳細(xì)說(shuō)明。

上例中如果去把類中的 str 屬性去掉，那么生成的文檔又會(huì)有什么變化呢？你會(huì)發(fā)現(xiàn)，原來(lái)是 str, str()，而現(xiàn)在變成了 str(), str()，因?yàn)?str 屬性已經(jīng)沒(méi)有了，所以 str 也表示方法 str()。

2。 使用 @author、@version 說(shuō)明類

這兩個(gè)標(biāo)記分別用于指明類的作者和版本。缺省情況下 javadoc 將其忽略，但命令行開(kāi)關(guān) -author 和 -version 可以修改這個(gè)功能，使其包含的信息被輸出。這兩個(gè)標(biāo)記的句法如下：

@author 作者名

@version 版本號(hào)

其中，@author 可以多次使用，以指明多個(gè)作者，生成的文檔中每個(gè)作者之間使用逗號(hào) (,) 隔開(kāi)。

@version 也可以使用多次，只有第一次有效，生成的文檔中只會(huì)顯示第一次使用 @version 指明的版本號(hào)。如下例

/**

* @author Fancy

* @author Bird

* @version Version 1。

00

* @version Version 2。00

*/

public class TestJavaDoc {

}

生成文檔的相關(guān)部分如圖：

從生成文檔的圖示中可以看出，兩個(gè) @author 語(yǔ)句都被編譯，在文檔中生成了作者列表。

而兩個(gè) @version 語(yǔ)句中只有第一句被編譯了，只生成了一個(gè)版本號(hào)。

從圖上看，作者列表是以逗號(hào)分隔的，如果我想分行顯示怎么辦？另外，如果我想顯示兩個(gè)以上的版本號(hào)又該怎么辦？

——我們可以將上述兩條 @author 語(yǔ)句合為一句，把兩個(gè) @version 語(yǔ)句也合為一句：

@author Fancy

Bird

@version Version 1。

00

Version 2。00

結(jié)果如圖：

我們這樣做即達(dá)到了目的，又沒(méi)有破壞規(guī)則。@author 之后的作者名和 @version 之后的版本號(hào)都可以是用戶自己定義的任何 HTML 格式，所以我們可以使用

標(biāo)記將其分行顯示。

同時(shí)，在一個(gè) @version 中指明兩個(gè)用

分隔的版本號(hào)，也沒(méi)有破壞只顯示第一個(gè) @version 內(nèi)容的規(guī)則。

3。 使用 @param、@return 和 @exception 說(shuō)明方法

這三個(gè)標(biāo)記都是只用于方法的。

@param 描述方法的參數(shù)，@return 描述方法的返回值，@exception 描述方法可能拋出的異常。它們的句法如下：

@param 參數(shù)名 參數(shù)說(shuō)明

@return 返回值說(shuō)明

@exception 異常類名 說(shuō)明

每一個(gè) @param 只能描述方法的一個(gè)參數(shù)，所以，如果方法需要多個(gè)參數(shù)，就需要多次使用 @param 來(lái)描述。

一個(gè)方法中只能用一個(gè) @return，如果文檔說(shuō)明中列了多個(gè) @return，則 javadoc 編譯時(shí)會(huì)發(fā)出警告，且只有第一個(gè) @return 在生成的文檔中有效。

方法可能拋出的異常應(yīng)當(dāng)用 @exception 描述。由于一個(gè)方法可能拋出多個(gè)異常，所以可以有多個(gè) @exception。

每個(gè) @exception 后面應(yīng)有簡(jiǎn)述的異常類名，說(shuō)明中應(yīng)指出拋出異常的原因。需要注意的是，異常類名應(yīng)該根據(jù)源文件的 import 語(yǔ)句確定是寫出類名還是類全名。 　　示例如下：

public class TestJavaDoc {

/**

* @param n a switch

* @param b excrescent parameter

* @return true or false

* @return excrescent return

* @exception ng。

Exception throw when switch is 1

* @exception NullPointerException throw when parameter n is null

*/

public boolean fun(Integer n) throws Exception {

switch ( Value()) {

case 0:

break;

case 1:

throw new Exception("Test Only");

default:

return false;

}

return true;

}

}

使用 javadoc 編譯生成的文檔相關(guān)部分如下圖：

可以看到，上例中 @param b excrescent parameter 一句是多余的，因?yàn)閰?shù)只是一個(gè) n，并沒(méi)有一個(gè) b但是 javadoc 編譯時(shí)并沒(méi)有檢查。

因此，寫文檔注釋時(shí)一定要正確匹配參數(shù)表與方法中正式參數(shù)表的項(xiàng)目。如果方法參數(shù)表中的參數(shù)是 a，文檔中卻給出對(duì)參數(shù) x 的解釋，或者再多出一個(gè)參數(shù) i，就會(huì)讓人摸不著頭腦了。@exceptin 也是一樣。

上例程序中并沒(méi)有拋出一個(gè) NullPointerException，但是文檔注釋中為什么要寫上這么一句呢，難道又是為了演示？這不是為了演示描述多余的異常也能通過(guò)編譯，而是為了說(shuō)明寫異常說(shuō)明時(shí)應(yīng)考運(yùn)行時(shí) (RunTime) 異常的可能性。

上例程序中，如果參數(shù) n 是給的一個(gè)空值 (null)，那么程序會(huì)在運(yùn)行的時(shí)候拋出一個(gè) NullPointerException，因此，在文檔注釋中添加了對(duì) NullPointerException 的說(shuō)明。

上例中的 @return 語(yǔ)句有兩個(gè)，但是根據(jù)規(guī)則，同一個(gè)方法中，只有第一個(gè) @return 有效，其余的會(huì)被 javadoc 忽略。

所以生成的文檔中沒(méi)有出現(xiàn)第二個(gè) @return 的描述。

講到這里，該怎么寫文檔注釋你應(yīng)該已經(jīng)清楚了，下面就開(kāi)始講解 javadoc 的常用命令。

運(yùn)行 javadoc -help 可以看到 javadoc 的用法，這里列舉常用參數(shù)如下：

用法：

javadoc [options] [packagenames] [sourcefiles]

選項(xiàng)：

-public 僅顯示 public 類和成員

-protected 顯示 protected/public 類和成員 (缺省)

-package 顯示 package/protected/public 類和成員

-private 顯示所有類和成員

-d 輸出文件的目標(biāo)目錄

-version 包含 @version 段

-author 包含 @author 段

-splitindex 將索引分為每個(gè)字母對(duì)應(yīng)一個(gè)文件

-windowtitle 文檔的瀏覽器窗口標(biāo)題

javadoc 編譯文檔時(shí)可以給定包列表，也可以給出源程序文件列表。

例如在 CLASSPATH 下有兩個(gè)包若干類如下：

fancy。Editor

fancy。Test

fancy。editor。ECommand

fancy。editor。EDocument

fancy。editor。

EView

這里有兩個(gè)包 (fancy 和 fancy。editor) 和 5 個(gè)類。那么編譯時(shí) (Windows 環(huán)境) 可以使用如下 javadoc 命令：

javadoc fancy\Test。java fancy\Editor。

java fancy\editor\ECommand。java fancy\editor\EDocument。java fancy\editor\EView。java

這是給出 java 源文件作為編譯參數(shù)的方法，注意命令中指出的是文件路徑，應(yīng)該根據(jù)實(shí)際情況改變。

也可以是給出包名作為編譯參數(shù)，如：

javadoc fancy fancy。editor

用瀏覽器打開(kāi)生成文檔的 ml 文件即可發(fā)現(xiàn)兩種方式編譯結(jié)果的不同，如下圖：

用第二條命令生成的文檔被框架分成了三部分：包列表、類列表和類說(shuō)明。

在包列表中選擇了某個(gè)包之后，類列表中就會(huì)列出該包中的所有類；在類列表中選擇了某個(gè)類之后，類說(shuō)明部分就會(huì)顯示出該類的詳細(xì)文檔。而用第一條命令生成的文檔只有兩部分，類列表和類說(shuō)明，沒(méi)有包列表。這就是兩種方式生成文檔的最大區(qū)別了。

下面再來(lái)細(xì)說(shuō)選項(xiàng)。

-public、-protected、-package、-private 四個(gè)選項(xiàng)，只需要任選其一即可。它們指定的顯示類成員的程度。它們顯示的成員多少是一個(gè)包含的關(guān)系，如下表：

-private (顯示所有類和成員)

-package (顯示 package/protected/public 類和成員)

-protected (顯示 protected/public 類和成員)

-public (僅顯示 public 類和成員)

-d 選項(xiàng)允許你定義輸出目錄。

如果不用 -d 定義輸出目錄，生成的文檔文件會(huì)放在當(dāng)前目錄下。-d 選項(xiàng)的用法是

-d 目錄名

目錄名為必填項(xiàng)，也就是說(shuō)，如果你使用了 -d 參數(shù)，就一定要為它指定一個(gè)目錄。這個(gè)目錄必須已經(jīng)存在了，如果還不存在，請(qǐng)?jiān)谶\(yùn)行 javadoc 之前創(chuàng)建該目錄。

-version 和 -author 用于控制生成文檔時(shí)是否生成 @version 和 @author 指定的內(nèi)容。不加這兩個(gè)參數(shù)的情況下，生成的文檔中不包含版本和作者信息。

-splitindex 選項(xiàng)將索引分為每個(gè)字母對(duì)應(yīng)一個(gè)文件。

默認(rèn)情況下，索引文件只有一個(gè)，且該文件中包含所有索引內(nèi)容。當(dāng)然生成文檔內(nèi)容不多的時(shí)候，這樣做非常合適，但是，如果文檔內(nèi)容非常多的時(shí)候，這個(gè)索引文件將包含非常多的內(nèi)容，顯得過(guò)于龐大。使用 -splitindex 會(huì)把索引文件按各索引項(xiàng)的第一個(gè)字母進(jìn)行分類，每個(gè)字母對(duì)應(yīng)一個(gè)文件。

這樣，就減輕了一個(gè)索引文件的負(fù)擔(dān)。

-windowtitle 選項(xiàng)為文檔指定一個(gè)標(biāo)題，該標(biāo)題會(huì)顯示在窗口的標(biāo)題欄上。如果不指定該標(biāo)題，而默認(rèn)的文檔標(biāo)題為“生成的文檔(無(wú)標(biāo)題)”。該選項(xiàng)的用法是：

-windowtitle 標(biāo)題

標(biāo)題是一串沒(méi)有包含空格的文本，因?yàn)榭崭穹怯糜诜指舾鲄?shù)的，所以不能包含空格。

同 -d 類似，如果指定了 -windowtitle 選項(xiàng)，則必須指定標(biāo)題文本。

到此為止，Java 文檔和 javadoc 就介紹完了。javadoc 真的能讓我們?cè)?Java 注釋上做文章——生成開(kāi)發(fā)文檔。

Trackback:

。

全部

總結(jié)

以上是生活随笔為你收集整理的Java的文件流定义,java文件流的问题！急的全部?jī)?nèi)容，希望文章能夠幫你解決所遇到的問(wèn)題。

如果覺(jué)得生活随笔網(wǎng)站內(nèi)容還不錯(cuò)，歡迎將生活随笔推薦給好友。