为什么/ ** [newline]并不总是在Eclipse中插入包含@param和@return的Javadoc模板?

时间:2010-06-07 10:21:13

标签: java eclipse javadoc

我在Eclipse中记录代码,并且一直使用/ **后跟Enter a lot来插入Javadoc模板。但是,由于某些原因,这并不总是有效,它将创建用于编写注释的模板,但它不会自动插入@param和@return文本。如果我将完全相同的方法复制到另一个类,它将插入完整的模板。

如果有人能告诉我为什么在某些情况下不会这样做,那将是一个很大的帮助。

3 个答案:

答案 0 :(得分:7)

据我所知,当Eclipse不确定您要记录哪种方法时,通常会发生这种情况。

更可靠的方法是选择要创建JavaDoc的方法/类等,然后按ALT + SHIFT + J或右键单击类大纲中的方法并单击Source - >生成元素注释。

答案 1 :(得分:1)

它总是适用于我,除非我正在尝试添加文档的方法上面有一个注释。以下是一些代码和未记录的方法的示例,它不起作用:

public class Test {
    // Declare some fields. Bla bla bla.

    // ~ Constructors

    public Test() { // <-- If I insert /** above this line it fails to work
    }
}

我的修复通常是暂时声明一个将我的方法与注释分开的变量,以便Eclipse识别出我在做什么...

public class Test {
    // Declare some fields. Bla bla bla.

    // ~ Constructors
    int i;
    public Test() { // <-- If I insert /** above this line it works. Then discard the temp var.
    }
}

答案 2 :(得分:0)

偶尔会在最后一次构建火星时发生这种情况。重新启动Eclipse会修复它。似乎我真的需要每天重启Eclipse以避免像这样的随机问题。