JavaDoc命令使用说明
JavaDoc 命令使用说明
作者：未知
转贴自：网络收藏
点击数：25
javadoc 的命令行语法如下： javadoc [ options ] [ packagenames ] [ sourcefiles ] [ @files ] 参数可以按照任意顺序排列。下面分别就这些参数和相关的一些内容进行说明： " Packagenames 包列表。这个选项可以是一系列的包名（用空格隔开），例如 ng ng.reflect java.awt。不过，因为 javadoc 不递归作用于子包，不允许对包名使用通配符；所以你必须显示地列出希 望建立文档的每一个包。 " Sourcefiles 源文件列表。这个选项可以是一系列的源文件名（用空格隔开），可以使用通配符。javadoc 允许四种源文件：类源代码文件、包描述文件、总体概述文件、其他杂文件。 ◇ 类源代码文件：类或者接口的源代码文件。 ◇ 包描述文件：每一个包都可以有自己的包描述文件。包描述文件的名称必须是 package.html，与包 的.java 文件放置在一起。包描述文件的内容通常是使用 HTML 标记写的文档。javadoc 执行时将自动寻找 包描述文件。如果找到，javadoc 将首先对描述文件中<body></body>之间的内容进行处理，然后把处理结 果放到该包的 Package Summary 页面中，最后把包描述文件的第一句（紧靠<body>）放到输出的 Overview summary 页面中，并在语句前面加上该包的包名。 ◇ 总体概述文件：javadoc 可以创建一个总体概述文件描述整个应用或者所有包。总体概述文件可以被任 意命名，也可以放置到任意位置。-overview 选项可以指示总体概述文件的路径和名称。总体概述文件的 内容是使用 HTML 标记写的文档。javadoc 在执行的时候，如果发现-overview 选项，那么它将首先对文件 中<body></body>之间的内容进行处理；然后把处理后的结果放到输出的 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: * <img src=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
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 <a href={@docroot}/copyright.html>copyright</a> */ 假定生成文档的根目录是 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 <a href = Component.html#getComponentAt(int,int) > getComponentAt </a> 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 <a href=URL#Value>Label</a> 使用 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 提供的所有标记。不过，需要注意这些标记的使用是有位置限制的。其中可以出现
" 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 文档的脚注文本。
