生成 Javadoc

打开 Javadoc 向导 生成 Javadoc 向导允许您生成 Javadoc。这是 Java JDK 中提供的 javadoc.exe 工具的用户界面。请访问 Sun 公司的 Javadoc Tool 页面以获取 Javadoc 工具的完整文档。

第一个页面

类型选择:

选项

描述

选择将为其生成 Javadoc 的类型

在列表中,选择或清除框,以精确指定想要导出至 JAR 文件的类型。此列表是由工作台选择来初始化的。一次只能选择一个项目,因为运行 Javadoc 工具时一次只能使用一个项目的类路径。

为具有可视性的成员创建 Javadoc

  • 私有:将说明所有成员
  • :将只说明具有缺省、受保护或公共可视性的成员
  • 受保护:将只说明具有受保护或公共可视性的成员
  • 公共:将只说明具有公共可视性的成员(缺省值)


使用标准 Doclet

使用标准 doclet(缺省值)启动 Javadoc 命令

  • 目标:选择标准 doclet 将把生成的文档写至的目标。该目标是特定于 doclet 的参数,因此,当使用定制 doclet 时不启用它。


使用定制 Doclet

使用定制 doclet 来生成文档

  • Doclet 名称:doclet 的限定类型名
  • Doclet 类路径:doclet 类所需要的类路径


标准 doclet 参数

标准 Doclet 参数(当选择了使用标准 doclet 时可用):

选项

描述

文档标题

指定文档标题。
生成“使用”页面 如果想要文档包含“使用”页面,则选择此选项。
生成层次结构树 如果想要文档包含“树”页面,则选择此选项。

生成导航器栏

如果想要文档包含导航栏(页眉和页脚),则选择此选项。
生成索引 如果想要文档中包含“索引”页面,则选择此选项。
生成每个字母的索引 创建每个字母的索引。当选择了生成索引时启用此选项。 
@author 如果想要说明 @author 标记,则选择此选项。
@version 如果想要说明 @version 标记,则选择此选项。
@deprecated 如果想要说明 @deprecated 标记,则选择此选项。
建议不要使用的列表 如果想要文档包含“建议不要使用”页面,则选择此选项。当选择了 @deprecated 选项时启用此选项。
选择 Javadoc 应该创建与其进行链接的引用类 指定引用其他类型时 Javadoc 应该创建与其进行链接的其他文档。
  • 全部选中:创建与其他所有文档位置的链接
  • 全部清除:不要创建与其他文档位置的链接
  • 配置:配置引用的 JAR 或项目的 Javadoc 位置
样式表 选择要使用的样式表

常规参数

常规 Javadoc 选项:

选项

描述

概述

指定 Javadoc 应该从给定的文件中检索概述文档的文本。它将放置在 overview-summary.html 中。

其他 Javadoc 选项

在此处添加任何数目的其他选项:定制 doclet 选项、VM 选项或 JRE 1.4 兼容性选项。
注意,包含空格的参数必须用引号引起来。对于指定 html 代码(例如,-header)的参数,使用   或 " 来避免空格和引号。

将此 Javadoc 导出的设置另存为 Ant 脚本

指定存储将执行指定的 Javadoc 导出而不需要使用向导的 Ant 脚本。可以使用此向导来修改现有 Ant 脚本(使用生成的 Ant 脚本的上下文菜单的打开 Javadoc 向导)。

在浏览器中打开生成的索引文件 在浏览器中打开生成的 index.html 文件(仅在使用标准 doclet 时才可用)。

完成以开始生成 Javadoc。如果目标与配置了项目的 Javadoc 位置页面的位置不同,则将询问您是否想要将项目的 Javadoc 位置设置为新的目标文件夹。为此,“打开外部 Javadoc”的所有调用将使用现在所创建的文档。

将启动新进程,并且在背景中执行生成。打开“控制台”视图(窗口 > 显示视图 > 控制台)以查看生成的进度和状态。

相关任务

创建 Javadoc 文档

相关参考

文件操作
Javadoc 位置属性