jar和javadoc命令的使用

-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文档标记

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 © 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

*/