?
快捷搜索:  as  test  1111  test aNd 8=8  test++aNd+8=8  as++aNd+8=8  as aNd 8=8

云頂國際在線賭場:JBuilder2005創建開發文檔之Javadoc

?

雖然軟件工程中把具體設計作為軟件項目的一個緊張的階段,但在實踐中每每沒有獲得落實。并不是這個階段不緊張,而是實施有很大年夜的艱苦,由于軟件需求是生成的易動癥患者,十分艱苦具體設計出云頂國際在線賭場來后,需求已和當初的版今大年夜相徑庭,而花費偉大年夜,精雕細琢的具體設計已變成昨日黃花了。另一方面,有一些功能實現每每要等到真正編碼時才能想到更好的措施,終究設計時是"憑理想象",而編碼時才是"實踐操作",以是在編碼時對原設計進行調劑經常在所難免。

具體設計文檔是源代碼實現上的描述,但在物理上則是和源代碼文件分離的,兩者間的同等性很輕易被突破,保持兩者同等性價值經常是項目正常周期無法遭遇的。各類"自文檔"或"直接文檔"的技巧應運而生,Javadoc便是Java的自文檔技巧,即經由過程"寄生"在源代碼文件中的注釋信息孕育發生贊助文檔,這種贊助文檔本身也便是具體設計文檔。因為法度榜樣代碼和注釋信息在同一個文件中,在變動法度榜樣時響應調劑注釋則是舉手之勞的事,兩者間的同等性很輕易獲得保障。

作為一名Java法度榜樣員,想必若干看過JDK的API贊助文檔,JBuilder自帶的JDK1.4的贊助文檔位于/doc/jdk_docs.jar,它包孕了JDK的Javadoc文檔,你可以經由過程諸如winRAR等解壓軟件將jdk_doc.jar解壓到某個目錄下,解壓后jdk_docs云頂國際在線賭場/java/api目錄中的文檔便是JDK的Javadoc文檔。雙擊打開目錄下的index.html文件,你將看到如下的頁面

圖 1 JDK的Javadoc文檔

網頁分為三個幀,左上角的幀是包的列表,左下角的幀是包中類的列表,而右邊主窗口幀是類的API闡明頁面。

類API闡明頁面頂部有一個導航條,方便鏈接到一些常用的頁面,這些常見的頁面包括:

·Overview:所有包的闡明列表,每個包對應表中一行闡明。

·Package:包中所有類或接口的闡明列表,每個類或接口對應表中一行闡明。

·Class:標明為當前類,其上并無鏈接。

·Use:類的所有關聯類:包括承襲關系,依附關系,關聯關系等。

·Tree:以層次布局列出包中類繼層級關系,經由過程這個列表,可以對類探本溯源,下面是java.applet包Applet類的承襲用實現樹。

圖 2 以層次布局列出包中的類

·Deprecated:所有過時的類、接口、值域、措施、云頂國際在線賭場構造函數。

·Index:索引頁面,將JDK中所有的類、接口、常量、措施都以字母順序進行索引,借此頁面可以快速定位到所需的贊助內容,其頁面如下:

圖 3 以索引要領組織

·Help:關于若何應用Javadoc文檔的贊助信息,你可以經由過程這個文檔懂得更多應用Javadoc的措施。

每一個類和接口都對應一個Javadoc文檔,類和接口云頂國際在線賭場的Javadoc文檔所占比云頂國際在線賭場例最大年夜、內容最富厚,它是應用這些類和接口的直接參考文檔。因為類比接口包孕了更多的內容,以是我們僅先容類的文檔。一個范例的類Javadoc文檔包括以下的內容:

·導航條:在文檔頭部和尾部都有導航條,方便快速鏈接到常用的頁面,供給了上一頁和下一頁的鏈接,并且供給了在定位到本頁中不合部分的錨鏈接。

免責聲明:以上內容源自網絡,版權歸原作者所有,如有侵犯您的原創版權請告知,我們將盡快刪除相關內容。

您可能還會對下面的文章感興趣:

快三平台开户