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

Question

拥有现有的 Java 方法，例如：

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

    return 0;
}

我想在 Eclipse 中创建一个模板（名为 myDoc）。当我在方法上方键入它并按 Enter 时，它应该给我：

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

    return 0;
}

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

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

/**
 * 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;
}

我知道坏的 cmets，而且我知道在某些情况下它可能像在 API 中一样有用，上面的方法只是一个示例。

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

这是路径吗？

Answer 1

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

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