Javadocs

JavaDoc 作用域

请在此区域指定要生成 Javadoc 的文件、文件夹和包的子集。

这个 scope可以是整个项目、最近修改的文件、当前文件、自定义 scope 等等。

包含测试源

将测试的文档注释包含在生成的 Javadoc 中。

在 -sourcepath 中包含 JDK 和库源

如果选中此复选框，则 JDK 和库源路径将传递到 Javadoc 工具。 有关更多信息，请参阅 Javadoc 文档。

链接到 JDK 文档（使用 -link 选项）

如果选择此复选框，对 JDK 类和包的引用将变成链接，这对应于使用 Javadoc 工具的 -link 选项。

只有在 文档路径 选项卡的 SDK 设置中指定了在线文档链接时，此复选框才会启用。

如需更多信息，请参阅 Javadoc 文档。

输出目录

指定生成的文档将存储的目录的完全合格路径。 可手动输入路径，或点击 浏览 并在对话框中选择位置。 指定的值会传递给 Javadoc 实用工具的 -d 参数。 如果您的系统中未存在指定目录，您将被提示创建该目录。

可见性级别

指定您要在生成的文档中包含的成员可见性级别：

• 公开 ：仅包含 public 类和成员。 该级别对应于 -public Javadoc 参数。

• protected ：仅包含 public 和 protected 类及成员。 该级别对应于 -protected Javadoc 参数。

• 软件包 ：包含除 private 之外的所有类和成员。 该级别对应于 -package Javadoc 参数。

• 私有 ：包括所有类和成员。 该级别对应于 -private Javadoc 参数。

生成层次结构树

生成类层次结构。 如果清除此复选框，将把 -notree 参数传递给 Javadoc。

生成导航栏

生成导航栏。 如果清除此复选框，将把 -nonavbar 参数传递给 Javadoc。

生成索引

生成文档索引。 如果清除此复选框，将把 -noindex 参数传递给 Javadoc。

每个字母单独的索引

为每个字母生成一个单独的索引文件。 如果清除此复选框，将把 -splitindex 参数传递给 Javadoc。

仅当选中了 生成索引 复选框时，此复选框才可用。

@使用

请记录 class 和 package 的使用情况。 选中后，复选框将对应 -use Javadoc 参数。

@author

包含 @author 段落。 选中此复选框后，该复选框对应于 -author Javadoc 参数。

@version

包含 @version 段落。 选中此复选框后，该复选框对应于 -version Javadoc 参数。

@deprecated

请包含 @deprecated 信息。 复选框被清除时， -nodeprecated 参数会传递给 Javadoc。

弃用列表

生成过时列表。 当复选框被清除时， -nodeprecatedlist 参数会传递给 Javadoc。

仅当选中了 @deprecated 复选框时，此复选框才可用。

语言区域

输入所需的区域设置。

命令行参数

输入要传递给 Javadoc 的附加参数。 请使用命令行语法。

最大堆大小

请输入 Java 虚拟机运行 Javadoc 使用的最大堆大小（以 Mb 为单位）。

生成文档并用浏览器打开

自动在浏览器中打开生成的 Javadoc。

对齐​样式​

定义 Javadoc 注释的对齐方式。

• 对齐形参说明 ：将参数描述与最长的参数名称对齐。 否则，描述与相应的参数名称之间以单个空格分隔。

• 对齐抛出异常说明 ：将抛出异常的描述与最长的异常名称对齐。 否则，描述与异常名称之间由一个空格分隔。

空行

定义在 Javadoc 注释中应插入空行的位置。

• 描述后 ：在 Javadoc 注释的描述部分之后自动插入一个空行。

• 形参说明后 ：在 @param 标签组之后自动插入一个空行。

• 返回标记后 ：在 @return 标签之后自动插入一个空行。

无效标记​​.

在此区域内，定义是否应保留无效的选项卡。

• 保留无效标记 ：保留 @invalidTag。

• 保留空 @param 标记 ：保留没有描述的 @param 标签。

• 保留空 @return 标记 ：保留没有描述的 @return 标签。

• 保留空 @throws 标记 ：保留没有描述的 @throws 标签。

其他

在此区域中，为 Javadoc 注释指定附加格式化选项。

• 启用前导星号 ：每行 Javadoc 注释都应以星号开头。

• 使用 @throws 而不是 @exception ：使用 @throws 选项卡。

• 在右边界已包装 ：将超出右边距的文本换行到下一行。

• 在空行生成"<p>" ：在空行上自动插入 </p> 选项卡。

• 保留空行 ：选中此复选框以保留手动添加的空行。

• 不已包装单行注释 ：请将简短的注释保持在一行中，并与开头和结尾的选项卡一起使用。

• 保留换行符 ：如果未选中此复选框（默认情况下），在重新格式化时不会保留换行符。 当需要将注释格式化在段落的边界内，以占用最小的空间时，这是非常方便的。

  如果选中此复选框，将保留换行符。

• 形参说明新起一行 ：将 Javadoc 参数的描述（如果有）放到新的一行。 它根据续行缩进值进行缩进。

• 续行缩进 ：在多行注释中缩进后续行。