Jar使用說明和JavaDoc的使用說明
Jar使用說明
功能說明：
Java歸檔工具
語法：
jar [ 命令選項 ] [manifest] destination input-file [input-files]
補充說明：
jar工具是個java應用程序，可將多個文件合并為單個JAR歸檔文件。jar是個多用途的存檔及壓縮工具，它基于ZIP和ZLIB壓縮格式。然而，設計jar的主要目的是便于將java applet或應用程序打包成單個歸檔文件。將applet或應用程序的組件(.class 文件、圖像和聲音)合并成單個歸檔文件時，可以用java代理(如瀏覽器)在一次HTTP事務處理過程中對它們進行下載，而不是對每個組件都要求一個新連接。這大大縮短了下載時間。jar還能壓縮文件，從而進一步提高了下載速度。此外，它允許applet的作者對文件中的各個項進行簽名，因而可認證其來源。jar工具的語法基本上與tar命令的語法相同。
命令選項
-c 在標準輸出上創建新歸檔或空歸檔。
-t 在標準輸出上列出內容表。
-x[file] 從標準輸入提取所有文件，或只提取指定的文件。如果省略了file，則提取所有文件；否則只提取指定文件。
-f 第二個參數指定要處理的jar文件。在-c(創建)情形中，第二個參數指的是要創建的jar文件的名稱(不是在標準輸出上)。在-t(表(或-x(抽取)這兩種情形中，第二個參數指定要列出或抽取的jar文件。
-v 在標準錯誤輸出設備上生成長格式的輸出結果。
-m 包括指定的現有清單文件中的清單信息。用法舉例：“jar cmf myManifestFile myJarFile *.class”
-0 只儲存，不進行 ZIP 壓縮。
-M 不創建項目的清單文件。
-u 通過添加文件或更改清單來更新現有的 JAR 文件。例如：“jar -uf foo.jar foo.class”將文件 foo.class 添加到現有的JAR文件foo.jar中，而“jar umf manifest foo.jar”則用manifest中的信息更新foo.jar的清單。
-C 在執行 jar 命令期間更改目錄。例如：“jar -uf foo.jar -C classes *”將classes目錄內的所有文件加到foo.jar中，但不添加類目錄本身。
程序示例
1:將當前目錄下所有CLASS文件打包成新的JAR文件：
jar cf file.jar *.class
2:顯示一個JAR文件中的文件列表
jar tf file.jar
3:將當前目錄下的所有文件增加到一個已經存在的JAR文件中
jar cvf file.jar *
javadoc使用說明
功能說明
Java API文檔生成器從Java源文件生成API文檔HTML頁。
語法：
javadoc [ 命令選項 ] [ 包名 ] [ 源文件名 ] [ @files ]
其中[ 包名 ]為用空格分隔的一系列包的名字，包名不允許使用通配符，如（*）。[ 源文件名 ]為用空格分隔的一系列的源文件名，源文件名可包括路徑和通配符，如（*）。[ @files ]是以任何次序包含包名和源文件的一個或多個文件。
補充說明
Javadoc解析Java源文件中的聲明和文檔注釋，并產生相應的HTML頁缺?。?，描述公有類、保護類、內部類、接口、構造函數、方法和域。
在實現時，Javadoc要求且依賴于java編譯器完成其工作。Javadoc調用部分javac編譯聲明部分，忽略成員實現。它建立類的內容豐富的內部表示，包括類層次和“使用”關系，然后從中生成HTML。Javadoc還從源代碼的文檔注釋中獲得用戶提供的文檔。
當Javadoc建立其內部文檔結構時，它將加載所有引用的類。由于這一點，Javadoc必須能查找到所有引用的類，包括引導類、擴展類和用戶類。
命令選項
-overview i>path/filename 指定javadoc應該從path/filename所指定的“源”文件中獲取概述文檔，并將它放到概述頁中（overview-summary.html）。其中path/filename 是相對于-sourcepath的相對路徑名。
-public 只顯示公有類及成員。
-protected 只顯示受保護的和公有的類及成員。這是缺省狀態。
-package 只顯示包、受保護的和公有的類及成員。
-private 顯示所有類和成員。
-help 顯示聯機幫助，它將列出這些javadoc和doclet命令行選項。
-doclet class 指定啟動用于生成文檔的docle 的類文件。該doclet定義了輸出的內容和格式。如果未使用-doclet選項，則javadoc使用標準doclet生成缺省HTML格式。該類必須包含start(Root)法。該啟動類的路徑由 -docletpath選項定義。
-docletpath classpathlist 指定doclet類文件的路徑，該類文件用-doclet選項指定。如果doclet已位于搜索路徑中，則沒有必要使用該選項。
-1.1 生成具有用Javadoc 1.1生成的文檔的外觀和功能的文檔。也就是說，頁的背景為灰色，用圖像做頁眉，使用bullet列表而不是表格，具有單層目的目錄結構，不包含繼承 API，不使?*** TML框架，并且不支持內部類。該選項還自動將索引分割成每個字母一個文件。如果想要這種外觀，則該選項比javadoc 1.1優越之處等于修正了一些錯誤。
-sourcepath sourcepathlist
當將包名傳遞到javadoc命令中時，指定定位源文件（.java）的搜索路徑。注意只有當用 javadoc命令指定包名時才能使用sourcepath選項 -- 它將不會查找傳遞到javadoc命令中的.java文件。如果省略-sourcepath，則javadoc使用類路徑查找源文件。
-classpath classpathlist 指定javadoc將在其中查找引用類的路徑 -- 引用類是指帶文檔的類加上它們引用的任何類。Javadoc將搜索指定路徑的所有子目錄。classpathlist可以包括多個路徑，彼此用逗號分隔。
-bootclasspath classpathlist 指定自舉類所在路徑。它們名義上是Java平臺類。這個bootclasspath是Javadoc將用來查找源文件和類文件的搜索路徑的一部分。在 classpathlist中用冒號（:）分隔目錄。
-extdirs dirlist 指定擴展類所在的目錄。它們是任何使用Java擴展機制的類。這個 extdirs是Javadoc將用來查找源文件和在文件的搜索路徑的一部分。在dirlist中用冒號（:）分隔目錄。
-verbose 在javadoc運行時提供更詳細的信息。不使用verbose選項時，將顯示加載源文件、生成文檔（每個源文件一條信息）和排序的信息。verbose選項導致打印額外的信息，指定解析每個java源文件的毫秒數。
-locale language_country_variant 指定javadoc在生成文檔時使用的環境。
-encoding name 指定源文件編碼名，例如EUCJIS/SJIS。如果未指定該選項，則使用平臺缺省轉換器。
-J[flag] 將flag直接傳遞給運行javadoc的運行時系統java。注意在J和flag之間不能有空格。
標準 Doclet 提供的選項
-d directory 指定javadoc保存生成的HTML件的目的目錄。省略該選項將導致把文件保存到當前目錄中。其中directory可以是絕對路徑或相對當前工作目錄的相對路徑。
-use 對每個帶文檔類和包包括一個“用法”頁。該頁描述使用給定類或包的任何 API 的包、類、方法、構造函數和域。對于給定類 C，使用類 C 的任何東西將包括 C 的子類、聲明為 C 的域、返回 C 的方法以及具有 C 類型參數的方法和構造函數。
-version 在生成文檔中包括 @version 文本。缺省地將省略該文本。
-author 在生成文檔中包括 @author 文本。
-splitindex 將索引文件按字母分割成多個文件，每個字母一個文件，再加上一個包含所有以非字母字符開頭的索引項的文件。
-windowtitle[title] 指定放入 HTML
相關文章：
>>Cookie的傳遞流程及安全問題
>>JAVA生成JPG縮略圖
>>上傳圖片的縮放處理
>>學習JSP的一些心得.jsp
>>怎樣打包成可執行的jar文件.jsp
>>開發晉級篇：Java性能優化技巧集錦
>>為何我寫的郵件發送程序不能正確發送郵件？
>>一個郵件發送的API（可以帶附件和群發）
JavaDoc命令使用說明
作者：未知 轉貼自：網絡收藏 點擊數：25
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選項可以指示總體概述文件的路徑和名稱?？傮w概述文件的內容是使用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 the getComponentAt method.
◇ @param parameter-name description 描述參數，從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-description 建立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?？梢猿霈F在方法或者構造器文檔注釋中的標記有：@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.java 1.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
* @param var signification
* @exception exception class name
* @return return_value return signification
*/
5、Association Description:關聯類文檔描述，在注釋當中需要參引其它文檔描述的地方，可在相應的注釋當中如下插入：
/** method description
* @param var signification
* @exception exception class name
* @return return_value return signification
* @see package.class#member label
*/
6、包描述文件：概括描述包的功能和設計概要。為每個包創建一個描述文件，命名為package.html，與包的java文件放在一起。
注：javadoc生成文檔時，會將該html文件的第一句放在package summary中，而把整個內容放在Overview summary中.
轉載自:Jar使用說明和JavaDoc的使用說明