Java Doc -overview 选项（使用 Eclipse）

Posted 2023-02-21

【中文标题】Java Doc -overview 选项（使用 Eclipse）

【英文标题】：Java Doc -overview option (Using Eclipse)

【发布时间】：2021-12-12 21:35:05

【问题描述】：

我正在使用 Eclipse 构建一个小型 Java 项目。我想在我的 Java 文档中包含项目概述，以便索引页面包含有关项目标题、其目的等的信息。

我知道我可以在我的项目中包含一个 ovwerview.html 页面并且已经完成了。

根据 Java 文档，我还读到我需要使用 -overview 选项来激活将 overview.html 合并到 Java Doc 的索引页面中： https://docs.oracle.com/javase/8/docs/technotes/tools/unix/javadoc.html#CHDGDJAH

但是，我不知道如何使用它。在 Eclipse 的 JavaDoc 向导的第三页上是包含 VM 选项的选项，因此我输入了 -overview "src/overview.html"，但这没有任何效果。我只是尝试了 -overview "overview.html" 但这也没有效果。

我该怎么做？

【参考方案1】：

在 Eclipse JavaDoc 向导中，您应该在第三页的顶部有一个“概述”字段。

如果是这样，您应该能够手动选择它，然后生成 javadoc。 如果没有，请考虑为 Eclipse 更新 JavaDoc 插件（如果可能）。

【讨论】：

我完全错过了那个，谢谢。