问题标签 [javadoc]

如果您使用过 javadoc，然后来到 doxygen，那么您可能知道我说我想念使从类到类和方法到方法的跳转变得容易的分层（基于框架）视图的意思。（对于那些没有看过它的人，想象一下 IDE 或文件系统中的树导航器）。

如果可能的话，我怎样才能让 Doxygen 包含导航树？

10 月份有人问了一个类似的问题，但这只是关于样式表的替代品，只有一个出现了。我想我正在寻找更重要的东西。

有没有办法只搜索 javadoc 注释（通过 Eclipse）？我只想在 javadoc 注释中查找文本...

这个问题让我想到了一个正则表达式来匹配包含一些指定文本的javadoc注释。

例如，查找所有包含以下内容的javadoc片段@deprecated：

我设法得到表达式/\*\*.*?@deprecated.*?\*/，但在某些情况下失败，例如：

它匹配从第一个javadoc片段到第三个javadoc片段的所有代码。

有人可以为此提供正则表达式吗？

如何将链接写入 javadocs？

目前，我有类似的东西：

生成Math.sqrt应该链接到java.lang.Math.sqrt(double)API 的文本，但是，它所做的只是生成文本，没有链接。

我已经生成了一个有据可查的接口。每个方法都有自己的 JavaDoc。实现此接口的类在逻辑上可能略有不同。

如何将 JavaDoc 从超类添加到现有的 JavaDoc。关键词

只将超类的 javaDoc 设置为当前方法。但是当我尝试添加一些单词时，超级方法的JavaDoc就消失了，比如

有谁知道我如何在不删除的情况下更新超级方法的 JavaDoc。

编辑：

关于 Brian Agnew 的回答，这很好但不是真正的答案；）

当您想要覆盖现有方法（如 Swing 中的 paint()）并想要描述如何从外部初始化或处理绘制行为时，您也可能遇到同样的问题。这不仅仅用于接口描述。

我正在尝试记录一个带注释的接口，并包含一个如何在 javadoc 中使用的示例。例如

但是，Javadoc 将我的注释视为 javadoc 指令（如 @param 等），因此只打印：

这是一个示例用法：

在生成的文档中。我能够阻止这种情况的唯一方法是在注释之前添加一个额外的字符，例如

但这看起来有点乱。

只是想知道是否有人有任何建议，谢谢。

我有以下功能：

我在我的 Javadoc 中看不到它（或我记录的任何其他内容）。这可能是什么原因？

Lucene 是否已将 jar 与 javadoc 分开？contrib 部分中的所有内容都分离了 javadoc jar，但在我看来核心没有。我对吗？

使用 Eclipse 3.4 Ganymede，我找不到为所有平台插件 api 添加 javadoc 支持的方法，但特别是对 JFace e Ui Forms 包。

打开链接到名为“插件依赖项”的库的任何 jar 的属性面板，我在“Javadoc 位置”节点中收到以下消息：

当前的类路径条目属于容器“插件依赖项”，它不允许用户修改其条目中的 Javadoc 位置”...

这是什么意思，我必须用一些有线的 javadoc 位置重新构建 Eclipse？

我开始使用一些其他人编写的 Java 代码。我必须理解、改变和测试它。作者现在不可用。该包有大约 50 个不同大小的文件（以及类）。如果我能看到/打印出方法（公共和私有）和公共变量的名称（就像它们在 Eclipse 的“大纲窗口”中可见），那就太好了。这真的有助于理解代码，因为我可以只看这个并理解每个类的一般用途。

除了生成 Javadoc 之外，我可以在 Eclipse 中执行此操作吗，因为 Javadoc 确实创建了太多细节？有 Eclipse 插件吗？或任何其他工具？

例子：

对于代表学生的 Class 文件，我可以得到：

...