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

Question

有一个现有的 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 名称之后放置描述，在 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;
}

我知道不好的评论，我知道在某些情况下它可能很有用，比如在 API 中，上面的方法只是一个例子。

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

这是路径吗？

Answer 1

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

Window -> Preferences -> Java -> 代码风格 -> 代码模板，展开 Comments 部分，选择 Methods 并单击 Edit... 按钮。