在Eclipse中编写注释以链接特定行

时间:2013-02-21 11:45:42

标签: java eclipse eclipse-plugin code-formatting

我在Java中使用Eclipse并且使用长长的类我需要这样的功能:在方法的顶部注释中(例如),有一个由该方法执行的操作列表。 对于列出的每个操作,我想将评论的一部分“超链接”到相关代码的特定行。

然后使用Ctrl +单击该行,我可以直接跳转到指定的行代码。

是否可以进行这样的操作?

由于

3 个答案:

答案 0 :(得分:7)

在您的问题下面的评论中,您说:

  

我如何链接方法?

看一下下面的例子:你可以按 ctrl +点击bar()的JavaDoc中的foo(),然后eclipse跳转到方法bar()

public class Example {

    /**
     * JavaDoc of foo(). This method executes {@link Example#bar()}
     */
    public void foo() {
        bar();
    }

    /**
     * Javadoc of bar().
     */
    public void bar() { }
}

Eclipse甚至提供@link的自动填充,类名和方法(手动输入#后)。

这就是你要找的东西吗?

答案 1 :(得分:1)

您可以使用JavaDoc @see标记:

/**
* @see MyClass#myMethod()
*/

这会在JavaDoc中生成一个超链接。

SRC:method-linking-anchoring-in-java

答案 2 :(得分:0)

Eclipse IDE允许您从方法调用到方法的定义(我认为'F3')。

除此之外,我认为没有办法设置“特殊”导航。请注意,如果你需要这样的东西,这是一个强有力的迹象表明你的方法太大了。重构它们。


开箱即用,如果您通过代码到HTML的漂亮打印机提供代码,您可以在评论中嵌入HTML超链接和锚点(javadoc或normal)。运气好的话,当你在网络浏览器中查看HTML化的源代码时,它们是可点击的。


当然,Eclipse可以遵循javadoc“链接”。显然标准标签不能链接到方法的深处,但我想你可以编写一个Eclipse插件,它支持非标准的javadoc标签,用于链接到嵌入式锚点及其导航。