2024年3月23日发(作者：)

JavaDoc命令使用说明

作者：未知 转贴自：网络收藏 点击数：25

javadoc的命令行语法如下：

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

参数可以按照任意顺序排列。下面分别就这些参数和相关的一些内容进行说明：

" Packagenames 包列表。这个选项可以是一系列的包名（用空格隔开），例如 t

。不过，因为javadoc不递归作用于子包，不允许对包名使用通配符；所以你必须显示地列出希

望建立文档的每一个包。

" Sourcefiles 源文件列表。这个选项可以是一系列的源文件名（用空格隔开），可以使用通配符。javadoc

允许四种源文件：类源代码文件、包描述文件、总体概述文件、其他杂文件。

◇ 类源代码文件：类或者接口的源代码文件。

◇ 包描述文件：每一个包都可以有自己的包描述文件。包描述文件的名称必须是，与包

的.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目录。举个例子，你希望在的HTML文档中

使用一幅按钮的图片（）。首先，你必须把图片文件放到C:usersrcjavaawtdoc-files中；然

后在文件中加入下面注释

/**

* This button looks like this:

*

*/

" @files 包含文件。为了简化javadoc命令，你可以把需要建立文档的文件名和包名放在一个或多个文本

文件中。例如，为了简化下面命令：

javadoc -d apidoc age1 age2 age3

你可以建立一个名称为的文件，其内容如下：

age1

age2

age3

然后执行下面命令即可：

javadoc -d apidoc @

" options 命令行选项。javadoc使用doclets（doclets是指用doclet API编写的程序。）来确定输出

的内容和格式。命令行选项中一部分是可用于所有doclet的通用选项，一部分是由默认的标准doclet提

供的专用的选项。下面对各自一些常用的选项分别进行介绍：

通用选项：

◇ -1.1 生成具有javadoc 1.1版本生成的文档的外观和功能的文档。不是所有的选项都可以用于-1.1选

项，具体可以使用javadoc -1.1 -help察看。

◇ -help 显示联机帮助。

◇ -bootclasspath classpathlist 指定根类（通常是Java平台自带的一些类。例如.*等）的

路径。

◇ -sourcepath sourcepathlist 指定包的源文件搜索路径。但是必须注意，只有在javadoc命令中指定

了包名的时候才可以使用-sourcepath选项。如果指定了包名，而省略了-sourcepath，那么javadoc使用

类路径查找源文件。举例说明：假定你打算为age建立文档，其源文件的位置是C:usersrc。

那么你可以使用下面的命令：

javadoc -sourcepath c:usersrc age

◇ -classpath classpathlist 指定javadoc查找引用类的路径。引用类是指带文档的类加上它们引用的

任何类。javadoc将搜索指定路径的所有子目录。Classpathlist可以包含多个路径（使用;隔开）。如果

省略-classpath，则javadoc使用-sourcepath查找源文件和类文件。举例说明：假定你打算为

age建立文档，其源文件的位置是C:usersrc，包依赖C:userlib中的库。那么你可以使用下面

的命令：

javadoc -classpath c:userlib -sourcepath c:usersrc age

◇ -overview pathfilename 告诉javadoc从pathfilename所指定的文件中获取概述文档，并且把它放到

输出的概述页面（）中。其中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文档的脚注文本。