生成 Javadoc
向导允许您生成 Javadoc。这是 Java JDK 中提供的 javadoc.exe 工具的用户界面。请访问 Sun 公司的 Javadoc Tool 页面以获取 Javadoc 工具的完整文档。
类型选择:
|
选项 |
描述 |
|---|---|
|
Javadoc 命令 |
指定用于生成 Javadoc 的命令。 |
|
选择将为其生成 Javadoc 的类型 |
在列表中,选中或清除复选框,以精确指定要导出的类型。此列表是由工作台选择来初始化的。 |
|
为具有可视性的成员创建 Javadoc |
|
|
使用标准 Doclet |
使用标准 Doclet(缺省值)启动 Javadoc 命令
|
|
使用定制 Doclet |
使用定制 Doclet 来生成文档
|
标准 Doclet 参数(当选择了使用标准 Doclet 时可用):
|
选项 |
描述 |
|---|---|
|
文档标题 |
指定文档标题。 |
| 生成“使用”页 | 如果想要文档包含“使用”页,那么选择此选项。 |
| 生成层次结构树 | 如果想要文档包含“树”页,那么选择此选项。 |
|
生成导航器栏 |
如果想要文档包含导航栏(页眉和页脚),那么选择此选项。 |
| 生成索引 | 如果想要文档中包含“索引”页,那么选择此选项。 |
| 按每个字母将索引分开 | 创建每个字母的索引。当选择了生成索引时启用此选项。 |
| @author | 如果想要说明 @author 标记,那么选择此选项。 |
| @version | 如果想要说明 @version 标记,那么选择此选项。 |
| @deprecated | 如果想要说明 @deprecated 标记,那么选择此选项。 |
| 建议不要使用的列表 | 如果想要文档包含“建议不要使用”页,那么选择此选项。当选择了 @deprecated 选项时启用此选项。 |
| 选择应该生成其链接的所引用归档和项目 |
指定引用其他类型时 Javadoc 应该创建与其进行链接的其他文档。
|
| 样式表 | 选择要使用的样式表 |
常规 Javadoc 选项:
|
选项 |
描述 |
|---|---|
|
概述 |
指定 Javadoc 应该从给定的文件中检索概述文档的文本。它将放置在 overview-summary.html 中。 |
|
VM 选项 |
在此处添加任意数目的附加 VM 选项。 |
|
其他 Javadoc 选项 |
在此处添加任意数目的附加选项:定制 Doclet 选项或 JRE 1.4 兼容性选项。 |
|
JRE 源代码兼容性 |
Javadoc 工具接受的 JRE 源代码兼容性。 |
|
将此 Javadoc 导出的设置另存为 Ant 脚本 |
指定存储将执行指定的 Javadoc 导出而不需要使用向导的 Ant 脚本。可以使用此向导来修改现有 Ant 脚本(使用生成的 Ant 脚本的上下文菜单的打开 Javadoc 向导)。 |
| 在浏览器中打开生成的索引文件 | 在浏览器中打开生成的 index.html 文件(仅在使用标准 Doclet 时才可用)。 |
按完成以开始生成 Javadoc。如果目标与配置了项目的 Javadoc 位置页面的位置不同,那么将询问您是否想要将项目的 Javadoc 位置设置为新的目标文件夹。为此,“打开外部 Javadoc”的所有调用将使用现在所创建的文档。
将启动新进程,并且在背景中执行生成。打开“控制台”视图(窗口 > 显示视图 > 控制台)以查看生成的进度和状态。