仔細觸摸Java編程中的“文檔”和“包”

什麼是包 　　Java中的包(Package)其實指的就是目錄，它是為了更好地管理Java類(Class)和介面(Interface)。Java語言的包可以被另一個Java開發包所使用。如果我們要引用某個包中的類，用import關鍵字來標明即可。比如： 　　import java.util. 　　date=new Date 　　 　　提示：import java.util.表示java.util中的所有公有類和介面被引入到當前包。這裡的匹配符可以調入多個類名。 　　常用的Java標準包 　　JDK為我們提供了很多標準的Java類和介面，這些包是寫Java程式所必需的，知道了每種包所包含的類和介面，並且熟悉這些類和介面是每個Java編程人員都應該掌握的基本技能。 　　Java中常用的包有：Java.applet、java.awt、java.i、java.lang、java.net和java.util等等。其中java.applet包含了一些設計小應用程式(Applet)的類和介面；java.awt是一個視窗工具箱包(awtAbstract Window Toolkit)，裡面是一些GUI介面相關的類；java.io包支援輸入輸出，比如檔案輸入資料流類：FileInputStream等；java.lang包含線程、異常、系統、整數等相關的類，是Java程式中預設載入的一個包；java.net這個類支援TCP/IP網路通訊協定，並包含Socket類及URL相關的類，是網路編程中要使用的；java.util包含一些程式的公用類，如DateDictionary等等。 　　除了上面提到的一些標準包之外，還有很多其它的包，比如資料庫編程時我們可能需要使用java.sql包，寫網路程式還會用到java.rmi包(RMIRemote Method Invocation)等。另外，Javax.包是一些標準包的擴充，常用的包有：javax.swing、javax.sound。 　　自己動手建立包 　　Java中的包是可以自己建立的。我們可以將很多功能相近的類和介面放在同一個包中，以方便管理和使用。 　　建立包的基本方法 　　1.定義Public類； 　　2.首句加“Package包名”； 　　3.將Java檔案產生的Class放在以包名為目錄名的目錄中 　　4.在其它程式中用“import包名”就可以存取此包中的所有Public類。 　　包的建立和使用 　　//filenameB.java 　　package com.chen.test//定義一個包 　　public class B//定義一個類 　　public void addint iint j//兩個數求和，並輸出 　　System.out.printlni+j 　　上面的代碼便是為了建立一個簡單的包：com.chen.test，我們將這個檔案命名為B.java。現在運行javac -d C/ B.java編譯該包(該命令在C盤下產生com/chen/test目錄，並將編譯結果儲存在B.class中)。現在我們進入C/com/chen/test目錄可以看到編譯產生的Class檔案也包含在內了。 　　OK，現在這個包已經建立好了，這時需要你做的是把C/com/chen/test設定在你的環境變數classpath裡。 　　如何調用包 　　現在我們再用一個小程式來調用上面建立的包： 　　//filenameA.java 　　import com.chen.test.//引入剛才建立的包 　　public class A 　　public static void mainStringargs 　　B test = new B 　　test.add68//用add調用自訂包 　　將上面的Java代碼儲存為C/A.java然後編譯：javac C/A.java。 　　提示：對於包檔案B.java，你可以不編譯而只將它放到C/com/chen/test目錄下即可。要注意的是，A.java和B.java兩個檔案不可以放在相同目錄下，這樣就會出錯。 　　Java文檔及Javadoc 　　除了包之外，Java文檔也是Java編程中非常重要的一個概念。Java文檔就是Java程式的協助文檔。一般情況下，我們先寫好協助文檔，再利用工具Javadoc來產生相應的文檔。Javadoc是JDK提供的一個文檔產生工具，它利用Java編譯器Javac對程式碼源檔案中的聲明和文檔注釋進行文法分析，並在預設情況下產生一組HTML文檔來描述類、內部類、介面、建構函式、方法和域。Javadoc注釋以“/”開始，以“/”結束，裡面可以包含普通文本、HTML標記和Javadoc標記。Javadoc只處理源檔案中在類/介面定義、方法、域、構造器之前的注釋，忽略其它地方的注釋。 　　掌握Javadoc 　　現在我們先用一個常式來說明Javadoc標記的意義： 　　/ 　　我的JavaDoc測試程式--JavaDocTest 　　@author warton2003西安 　　test<--這裡可以嵌入HTML本句為HTML注釋--> 　　@version 0.1 2004/01/01 　　/ 　　public class JavaDocTest 　　 　　/ 　　在main中要使用字串 　　@see #mainjava.lang.String 　　/ 　　static String SDisplay 　　/ 　　顯示Javadoc測試 　　@param args命令列參數 　　@return沒有傳回值 　　/ 　　public static void mainString args 　　 　　SDisplay =″Javadoc測試″ 　　System.out.printlnSDisplay 　　在這個Java程式裡面，使用了大量的Javadoc標記、文本以及HTML標記。Javadoc標記以“/”開始，表明這些都是Java代碼的注釋。“@”開頭的標記就是Javadoc標記。 　　Javadoc標記有兩種：獨立(Standalone)標記和內聯(Inline)標記。獨立標記也就是那些常見的標記，如@param、@return和@author等；另一種類型的標記是內聯標記這種標記採用@tag的形式它允許開發人員建立超級連結從注釋部分連結到其它的Javadoc頁面或者本頁面的其它地方。 　　提示：在Java來源程式裡正確使用Javadoc標記是非常必要的注釋習慣，將有助於Javadoc自動以原始碼檔案產生完整的格式化API文檔。 　　OK，那麼我們先看看Javadoc是如何產生漂亮的文檔!將上面的代碼儲存到JavaDocTest.java並編譯。 　　運行：javadoc -private -d doc -auth 　　or -version JavaDocTest.java 　　這時，Javadoc程式會根據JavaDocTest.java產生一個doc目錄，裡面有很多HTML檔案，這些就是Javadoc產生的API協助文檔。 　　Javadoc命令列文法 　　光會使用標記還不能很好利用Javadoc提供的功能，必須能使用它的命令列才行。最後向大家介紹一下簡單的Javadoc命令。 　　Javadoc的命令列文法如下： 　　javadoc options packagenames sourcefiles @files 　　 　　提示：對於一般的應用，我們只須使用javadoc yourjavafile.java這樣的命令列產生協助文檔就行了。如果你需要定製協助文檔，才會用到參數，一般情況下你可以使用javadoc help命令來查看Javadoc的協助文檔。 　　總之，Javadoc提供了完整規範的API文檔功能。在軟體專案管理和開發中，合理地使用Javadoc不僅可以減少開發時的文檔工作量，提高效率，而且還非常有利於將來軟體的修改和維護。 　　Javadoc標記的一些詳細說明： 　　@author指定產生文檔中的“作者”項，可以指定多個author。在左面的代碼中，author後面還加了一個HTML標記，用來連結URL。都是HTML標記，<-- -->則是HTML注釋。 　　@version指定版本資訊。 　　@see標記是比較複雜的。@see″string″為“string”添加文本項，不產生任何連結。@see Label 使用HTML標記產生連結。@see package.class#member Label。 　　@param標記用來描述參數。 　　@return標記用來描述傳回值。 　　@link為內聯標記，內聯標記的通常格式是：@linkpackage.class#member label 　　提示：Label是位於注釋中間的文本，package.class#member指向一個具體的類或者方法。以下是一些例子： 　　連結到同一類的屬性，使用：@link#KEY 　　連結到同一類的方法，使用：@link#getComponentAtintgetComponentAt 　　連結到其它類，使用@linkjava.util.Map Map