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

发布于 2024-09-05 07:13:39 字数 198 浏览 6 评论 0原文

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

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

原文

分享到QQ

分享到微博

如果你对这篇内容有疑问，欢迎到本站社区发帖提问参与讨论，获取更多帮助，或者扫码二维码加入 Web 技术交流群。

发布评论

需要登录才能够评论，你可以免费注册一个本站的账号。

鹿港巷口少年归 2024-09-12 07:13:39

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

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

回复收藏 0 原文

乖乖哒 2024-09-12 07:13:39

它总是对我有用，除非我尝试添加文档的方法上方有注释。下面是一些代码和未记录的方法的示例，其中它不起作用：

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.
    }
}

It always works for me UNLESS there's a comment above the method I'm trying to add the documentation for. Here's an example of some code and an undocumented method where it wouldn't work:

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

    // ~ Constructors

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

My fix is usually to temporarily declare a variable that separates my method from the comments so the Eclipse recognises what I'm doing...

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.
    }
}

回复收藏 0 原文