这篇文章主要介绍“jar和javadoc的用法有哪些”,在日常操作中,相信很多人在jar和javadoc的用法有哪些问题上存在疑惑,小编查阅了各式资料,整理出简单好用的操作方法,希望对大家解答”jar和javadoc的用法有哪些”的疑惑有所帮助!接下来,请跟着小编一起来学习吧!
在钦南等地区,都构建了全面的区域性战略布局,加强发展的系统性、市场前瞻性、产品创新能力,以专注、极致的服务理念,为客户提供成都网站制作、网站建设 网站设计制作按需设计网站,公司网站建设,企业网站建设,成都品牌网站建设,成都全网营销,成都外贸网站建设,钦南网站建设费用合理。
jar使用说明功能说明:
Java归档工具
语法:
jar [ 命令选项 ] [manifest] destination input-file [input-files]
补充说明:
jar工具是个java应用程序,可将多个文件合并为单个JAR归档文件。jar是个多用途的存档及压缩工具,它基于ZIP和ZLIB压缩格式。然而,设计jar的主要目的是便于将java applet或应用程序打包成单个归档文件。
[@more@]
将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
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: * ![jar和javadoc的用法有哪些](http://blog.itpub.net/8672542/viewspace-896194/doc-files/Button.gif) */ • @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。可以出现在方法或者构造器文档注释中的标记有:@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的用法有哪些”的学习就结束了,希望能够解决大家的疑惑。理论与实践的搭配能更好的帮助大家学习,快去试试吧!若想继续学习更多相关知识,请继续关注创新互联网站,小编会继续努力为大家带来更多实用的文章!
当前文章:jar和javadoc的用法有哪些
当前地址:
http://cdkjz.cn/article/gsjegj.html