用于将javadoc插入现有方法的Eclipse模板

时间:2013-06-28 11:56:06

标签: java eclipse templates editor

拥有现有的Java方法,如:

public int someMethod(String arg1, int arg2) {
    //do something

    return 0;
}

我想在eclipse中创建一个模板(名为myDoc)。当我在方法上方输入并点击输入时,它应该给我:

/**
 * 
 * @param arg1
 * @param arg2
 * @customAt
 * @return
 */
public int someMethod(String arg1, int arg2) {
    //do something

    return 0;
}

我知道当你输入/ **然后按回车键时会发生这种情况,但是我想把自定义@s和占位符放在第一个@param之上,在@param名称之后放置描述并在返回之后描述返回的内容

在输入占位符的最后,我会这样:

/**
 * My method that does something
 * @param arg1 must be a valid string
 * @param arg2 must be greater than 0
 * @customAt my description
 * @return the code of...
 */
public int someMethod(String arg1, int arg2) {
    //do something

    return 0;
}

我知道错误的评论,我知道在某些情况下它可能像在API中一样有用,上面的方法只是一个例子。

我只是想知道如何做到这一点。我一直在玩插件开发,我在here中编写了插件示例。在示例中,您编写了一个模板变量,我认为可能就是这样,但我坚持使用 org.eclipse.jface.text.templates.TemplateVariableResolver 的resolve方法。我以为我可以访问光标的位置,并且我可以检测附近的方法来插入javadoc。

这是路径吗?

1 个答案:

答案 0 :(得分:0)

您可以更改默认方法javadoc模板。

Window - > Preferences - > Java - > Code Style - > Code Template,展开Comments部分,选择Methods,然后点击Edit...按钮。