是否有生成javadoc的工具自动生成@see对被调用方法的引用?

时间:2012-01-14 06:06:02

标签: javadoc

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

如果我有一个调用B,C和D的方法A,那么将javadoc附加到A的javadoc是很好的,它表示它调用B,C和D(以及@see链接到这些方法,所以你可以为他们读取javadoc)。

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

当然存在这样一个工具(可能是其中的多个),我敢打赌,对于哪一个是最好的,有很多意见。

2 个答案:

答案 0 :(得分:0)

我认为这样的工具不存在。我希望它没有。文档的目的是让事情更清晰,我认为如果在每个方法调用中添加@see,你最终会得到一堆意大利面条。 (好吃,但你想要排序。)你应该将@see限制在相关或相关的方法中。

当然,您可以将代码添加到javadoc中,可能是一种获取源代码方法调用以链接到Javadoc的方法。当然,您可以使用' Open Declaration(F3)'跳转到Eclipse中的方法声明。选项。

答案 1 :(得分:0)

使用“Doxygen”。

即使没有@see标签,您也可以获得功能关系。

请记住编辑conf文件,确保已打开“function_call”开关。(抱歉,我不太确定开关名称)

相关问题