是否有生成 javadoc 的工具可以自动生成对被调用方法的 @see 引用？答案

【问题标题】：Is there a tool to generate javadoc that automatically generates @see references to called methods?是否有生成 javadoc 的工具可以自动生成对被调用方法的 @see 引用？
【发布时间】：2012-01-14 06:06:02
【问题描述】：

我知道如何为方法生成简单的 javadoc，但我认为自动包含指向我的方法调用的方法的链接会非常有用。是否有任何工具可以扫描方法代码并自动在 javadoc 中为我放置对调用方法的 @see 引用？一个简单的例子：

如果我有一个调用 B、C 和 D 的方法 A，最好将 javadoc 附加到 A 的 javadoc 以指示它调用 B、C 和 D（以及指向这些方法的 @see 链接，以便您可以为他们阅读 javadoc）。

我真正需要的是一个工具，它可以生成流程文档，我所做的就是像往常一样记录我的代码，运行这个工具，然后我最终得到的文档会告诉我我的方法是什么确实，以及它调用的所有其他方法（最好按照调用方法的顺序）。

确实存在这样的工具（可能有多个），我敢打赌，对于哪个是最好的，有很多意见。

【问题讨论】：

标签： javadoc

【解决方案1】：

使用“Doxygen”。

不用@see标签也能得到函数的关系。

记得编辑conf文件，确保你打开了“function_call”开关。（对不起，我不太清楚开关名称）

【讨论】：

【解决方案2】：

我认为不存在这样的工具。我希望不会。文档的重点是让事情更清楚，我认为如果在每个方法调用中添加一个@see，你最终会得到一堆意大利面条。（很好吃，但没有你想整理的东西。）你应该将@see 限制为相关或相关的方法。

当然，您可以将代码添加到 javadoc 中，并且可能有一种方法可以让源代码方法调用链接到 Javadoc。当然，您可以使用“打开声明 (F3)”选项跳转到 Eclipse 中的方法声明。

【讨论】：

我在一个基于任务的框架中工作，其中每个任务类都非常小，并且调用的其他任务数量相对较少。在这种情况下，了解哪些任务调用其他任务将非常有帮助。不过，总的来说，我同意你的看法。