建体彩网|中彩网双色球连号|
?
快捷搜索:  as  test  1111  test aNd 8=8  test++aNd+8=8  as++aNd+8=8  as aNd 8=8

申博官網娛樂玩法:JavaDoc命令使用說明

?

javadoc的敕令行語法如下:

javadoc [ options ] [ packagenames ] [ sourcefiles ] [ @files ]

參數可以按照隨意率性順序排列。下面分手就這些參數和相關的一些內容進行闡明:

• Packagenames 包列表。這個選項可所以一系列的包名(用空格隔開),例如java.lang java.lang.reflect java.awt。不過,由于javadoc不遞歸感化于子包,不容許對包名應用通配符;以是你必須顯示地列出盼望建立文檔的每一個包。

• Sourcefiles 源文件列表。這個選項可所以一系列的源文件名(用空格隔開),可以應用通配符。javadoc容許四種源文件:類源代碼文件、包描述文件、總體概述文件、其他雜文件。

◇ 類源代碼文件:類或者接口的源代碼文件。

◇ 包描述文件:每一個包都可以有自己的包描述文件。包描述文件的名稱必須是"package.html",與包的.java文件放置在一路。包描述文件的內容平日是應用HTML標記寫的文檔。javadoc履行時將自動探求包描述文件。假如找到,javadoc將首先對描述文件中之間的內容進行處置懲罰,然后把處置懲罰結果放到該包的Package Summary頁面中,著末把包描述文件的第一句(緊靠)放到輸出的Overview summary頁面中,并在語句前面加上該包的包名。

◇ 總體概述文件:javadoc可以創建一個總體概述文件描述全部利用或者所有包。總體概述文件可以被隨意率性命名,也可以放置到隨意率性位置。-overview選項可以唆使總體概述文件的路徑和名稱。總體概述文件的內容是應用HTML標記寫的文檔。javadoc在履行的時刻,假如發明-overview選項,那么它將首先對文件中之間的內容進行處置懲罰;然后把處置懲罰后的結果放到輸出的Overview summary 頁面的底部;著末把總體概述文件中的第一句放到輸出的Overview summary頁面的頂部。

◇ 其他雜文件:這些文件平日是指與javadoc輸出的HTML文件相關的一些圖片文件、Java源代碼文件(.java)、Java法度榜樣(.class)、Java小法度榜樣(Applets)、HTML文件。這些文件必須放在doc-files目錄中。每一個包都可以有自己的doc-files目錄。舉個例子,你盼望在java.awt.Button的HTML文檔中應用一幅按鈕的圖片(Button.gif)。首先,你必須把圖片文件放到C:usersrcjavaawtdoc-files中;然后在Button.java文件中加入下面注釋

/**

* This button looks like this:

*

*/

• @files 包孕文件。為了簡化javadoc敕令,你可以把必要建立文檔的文件名和包名放在一個或多個文本文件中。例如,為了簡化下面敕令:

javadoc -d apidoc com.mypackage1 com.mypackage2 com.mypackage3

你可以建立一個名稱為mypackage.txt的文件,其內容如下:

com.mypackage1

com.mypackage2

com.mypackage3

然后履行下面敕令即可:

javadoc -d apidoc @mypackage.txt

• options 敕令行選項。javadoc應用doclets(doclets是指用doclet API編寫的法度榜樣。)來確定輸出的內容和款式。敕令行選項中一部分是可用于所有doclet的通用選項,一部分是由默認的標準doclet供給的專用的選項。下面對各自一些常用的選項分手進行先容:

通用選項:

◇ -1.1 天生具有javadoc 1.1版本天生的文檔的外不雅和功能的文檔。不是所有的選項都可以用于-1.1選項,詳細可以應用javadoc -1.1 -help不雅察。

◇ -help 顯示聯機贊助。

◇ -bootclasspath classpathlist 指定"根類"(平日是Java平臺自帶的一些類。例如java.awt.*等)的路徑。

◇ -sourcepath sourcepathlist 指定包的源文件搜索路徑。然則必須留意,只有在javadoc敕令中指定了包名的時刻才可以應用-sourcepath選項。假如指定了包名,而省略了-sourcepath,那么javadoc應用類路徑查找源文件。舉例闡明:假定你盤算為com.mypackage建立文檔,其源文件的位置是C:usersrc。那么你可以應用下面的敕令:

javadoc -sourcepath c:usersrc com.mypackage

◇ -classpath classpathlist 指定javadoc查找"引用類"的路徑。引用類是指帶文檔的類加上它們引用的任何類。javadoc將搜索指定路徑的所有子目錄。Classpathlist可以包孕多個路徑(應用;隔開)。假如省略-classpath,則javadoc應用-sourcepath查找源文件和類文件。舉例闡明:假定你盤算為com.mypackage建立文檔,其源文件的位置是C:usersrc,包依附C:userlib中的庫。那么你可以應用下面的敕令:

javadoc -classpath c:userlib -sourcepath c:usersrc com.mypackage

◇ -overview pathfilename 奉告javadoc從pathfilename所指定的文件中獲取概述文檔,并且把它放到輸出的概述頁面(overview-summary.html)中。此中pathfilename是相對付-sourcepath的相對路徑。

◇ -public 只顯示公共類以及成員。

◇ -protected 只顯示受保護的和公共的類以及成員。缺省選項。

◇ -package只顯示包、受保護的和公共的類以及成員。

◇ -private 顯示所有類和成員。

◇ -doclet class 指定javadoc孕育發生輸出內容的自定義doclet類。假如輕忽這個選項,javadoc將應用默認的doclet孕育發生一系列HTML文檔。

◇ -docletpath classpathlist 與- doclet選項相關,擬訂自定義的doclet類文件的路徑。Classpathlist可以包孕多條路徑(用;隔開)。

◇ -verbose 在javadoc運行時供給更具體的信息。

標準doclet專用選項:

◇ -author 在天生的文檔中包孕"作者"項。

◇ - d directory 指定javadoc保存天生的HTML文件的目錄。省略該選項將把文件保存在當前目錄。Directory可所以絕對目錄,也可所以相對當前目錄的相對目錄。

◇ -version 在天生的文檔中包孕"版本"項。

◇ -use 為類和包天生"use"(用法)頁面。這些頁面描述了該類和包在javadoc敕令涉及的文件中被應用的環境。例如:對付給定的類C,在C的用法頁面中將包孕C的子類,類型為C的域,返回變量類型為C的措施以及在參數中有變量類型為C的措施和構造器。

◇ -splitindex 把索引文件按照字母順序分為多個文件。每一個文件對應一個字母。

◇ -windowtitle title 指定輸出的HTML文檔的標題。

◇ -header header 指定輸出的HTML文檔的頁眉文本。

◇ -footer footer 指定輸出的HTML文檔的腳注文本。

◇ -bottom text 指定輸出的HTML文檔底部的文本。

◇ - group groupheading packagepatten;packagepatten;… 在總體概述頁面中按照敕令的指定要領分隔各個包。例如履行下面敕令:

javadoc -group "Core Packages" "java.lang*:java.util"

-group "Extension Packages" "javax.*"

java.lang java.lang.reflect java.util javax.servlet java.new

在頁面中將有如下結果:

Core Packages

java.lang

java.lang.reflect

java.util

Extension Packages

javax.servlet

Other Packages

java.new

◇ - noindex 不輸出索引文件。

◇ - help 在文件的導航條中輕忽help鏈接。

◇ - helpfile pathfilename 指定導航條中的help鏈接所指向的贊助文件。輕忽該選項,javadoc將天生缺省的贊助文件。

◇ -stylesheetfile pathfilename 指定javadoc的HTML樣式表文件的路徑。輕忽該選項,javadoc將自動孕育發生一個樣式表文件stylesheet.css。

JavaDoc文檔標記

javadoc注釋以"/**"開始,以"*/"停止,里面可以包孕通俗文本、HTML標記和javadoc標記。javadoc只處置懲罰源文件中在類/接口定義、措施、域、構造器之前的注釋,輕忽位于其他地方的注釋。舉例如下:

/**

*Demo--Helloworld

*@author sunjl

*@version 1.0 2001/10/15

*/

public class myHelloworld

{

/**

*在main( )措施中應用的顯示用字符串

*@see #main(java.lang.String[])

*/

static String SDisplay;

/**

*顯示HelloWorld

*@param args 從敕令行中帶入的字符串

*@return 無

*/

public static void main(String args[])

{

SDisplay = "Hello World " ;

System.out.println( SDisplay );

}

}

應用下面敕令:

javadoc -private -d doc -author -version myHelloworld.java

即可以天生漂亮的關于myHelloworld.java的API文檔了。

上面例子中以@開首的標記便是javadoc標記。在Java法度榜樣中精確應用javadoc標記是一個優越的注釋習氣,將異常有助于javadoc自動從源代碼文件天生完備的款式化API文檔。下面就對各類標記進行具體闡明。

◇ @author name-text 指定天生文檔中的"作者"項,從JDK/SDK 1.0開始引入。name-text可以指定多個名字(應用","隔開)。文檔注釋可以包孕多個類。

◇ {@docroot} 代表孕育發生文檔的根路徑,從JDK/SDK 1.3開始引入。用法舉例如下

/**

*see the copyright

*/

假定天生文檔的根目錄是doc,上面注釋所在的文件著末天生的文件是docutilityutl.html,那么"copyright"的鏈接會指向..copyright.html。

◇ @deprecated deprecated-text 添加注釋,注解不保舉應用該API。

◇ @exception class-name description @throw的同義標記,從JDK/SDK 1.0開始引入。

◇ {@link package.class#member label} 插入指向package.class#member的內嵌鏈接,從JDK/SDK 1.2開始引入。舉例闡明,假定注釋中有如下文檔:

/** Use the {@link #getComponentAt(int, int) getComponentAt} method. */

那么javadoc最畢天生的HTML頁面中將有如下內容

Use thegetComponentAtmethod.

◇ @param parameter-name des申博官網娛樂玩法cription 描述參數,從JDK/SDK 1.0開始引入。

◇ @return description 描述返回值,從JDK/SDK 1.0開始引入。

◇ @see reference 添加"拜見"標題,此中有指向reference的鏈接或者文本項,從JDK/SDK 1.0開始引入。@see標記有三種形式,下面分手闡明:

(1)、@see "string" 為"string"添加文本項,不孕育發生鏈接。

(2)、@see Label 應用HTML標記孕育發生鏈接

(3)、@see package.class#member Label 應用Java說話的名字package.class #member孕育發生鏈接。

◇ @serial field-description 用于缺省可序列化域的注釋,從JDK/SDK 1.2開始引申博官網娛樂玩法入。

◇ @serialField field-name field-type field-d申博官網娛樂玩法escription 建立Serializable類的serialPersistentFields成員的ObjectStreamField組件的文檔,從JDK/SDK 1.2開始引入。

◇ @serialData data-description data-description建立數據序列和類型的文檔,從JDK/SDK 1.2開始引入。

◇ @since since-text 使用since-text內容為文檔增添"since"標題,從JDK/SDK 1.1開始引入。

◇ @throws class-name description 與@exception同義。用class-name和description為輸出文檔添加"拋出"標題,從JDK/SDK 1.2開始引入。

◇ @version version-text 添加"版權"標題,從JDK/SDK 1.0開始引入。

上面先容了標準doclet供給的所有標記。不過,必要留意這些標記的應用是有位置限定的。此中可以呈現在類或者接口文檔注釋中的標記有:@see、{@link}、@since、@deprecated、@author、@version。可以呈現在措施或者構造器文檔注釋中的標記有:@see、{@link}、@since、@deprecated、@param、@return、@throws、@exception、@serialData。可以呈現在域文檔注釋中的有:@see、{@link}、@since、@desprecated、@serial、@serialField。

除了javadoc自身供給的標準標記以外,我們可以定制自己的標記嗎?當然可以。只必要對javadoc標準的doclet法度榜樣進行擴充即可。實際上,使用javadoc供給的doclet API,不僅可以擴充doclet標記,以致還可以改變javadoc的全部輸出。為了滿意必要,你可以使javadoc輸出通俗文本、XML文件等。因為擴充doclet涉及到Java編程,本文不再做深入先容。

總之,javadoc供給了完備規范的API文檔功能。在軟件項目治理中,合理地應用javadoc不僅可以削減開拓時的文檔事情量,前進效率;而且還異常有利于將來軟件的改動和掩護。

JavaDoc 書寫規范:

1、 File Header Comments : 每個文件都應該加上文件頭標記,包括文件名、改動歷史、版權信息和附加信息。例如:

/**

* @(#)demo.java1.00 2002/05/27

*

* Copyright (c) 2000-2002 中國安全保險株式會社 版權所有

* Ping An Insurance Company of China. All rights reserved.

* This software is the confidential and proprietary

* information of Ping An Insurance Company of China.

* ("Confidential Information"). You shall not disclose

* such Confidential Information and shall use it only

* in accordance with the terms of the contract agreement

* you entered into with Ping An.

*/

2、class description:類信息,概括的描述類的功能和實現。

/** class description

*/

3、Variable Description:描述變量的意義和取值含義。

/** var variable description

*/

4、Method Description:標明每個措施的輸入、輸出參數和返回值類型,闡明特殊變量取值的含義。相關類文檔鏈接。

/** method description

* @paramvarsignification

* @exceptionexceptionclass name

* @returnreturn_valuereturn signification

*/

5、Association Description:關聯類文檔描述,在注釋傍邊必要參引其它文檔描述的地方,可在響應的注釋傍邊如下插入:

/** method description

* @paramvarsignification

* @exceptionexceptioncl申博官網娛樂玩法ass name

* @returnreturn_valuereturn s申博官網娛樂玩法ignification

* @seepackage.class#member label

*/

6、包描述文件:概括描述包的功能和設計概要。為每個包創建一個描述文件,命名為package.html,與包的java文件放在一路。

注:javadoc天生文檔時,會將該html文件的第一句放在package summary中,而把全部內容放在Overview summary中.

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

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

建体彩网
腾讯分分彩推荐 3d开机号试机号近30期 秒速时时彩 玩吃鸡游戏对青少年有害吗 青鹏棋牌官方网站下载 玩五子棋的技巧 广东十一选五 快速赛车骗人 山西十一选五的走势图 三张牌翻开