Почему / ** [newline] не всегда вставляет шаблон Javadoc, включая @param и @return, в Eclipse? - PullRequest
7 голосов
/ 07 июня 2010

Я документирую код в Eclipse и использую / **, а затем Enter много, чтобы вставить шаблон Javadoc. Однако это не всегда работает по какой-то причине, оно создаст шаблон для написания комментариев, но не будет автоматически вставлять текст @param и @return. Если я скопирую тот же самый метод в другой класс, он вставит полный шаблон.

Было бы очень полезно, если бы кто-нибудь мог сказать мне, почему он не делает этого в некоторых ситуациях.

Ответы [ 3 ]

7 голосов
/ 07 июня 2010

Насколько я знаю, это обычно происходит, когда Eclipse не знает наверняка, какой метод вы хотите документировать.

Более надежный способ - выбрать метод / класс и т. Д., Которые вы хотите создать.JavaDoc для и нажмите ALT + SHIFT + J или щелкните правой кнопкой мыши на методе в схеме класса и выберите Source -> Generate element comment.

1 голос
/ 20 апреля 2011

Это всегда работает для меня, если только над методом, к которому я пытаюсь добавить документацию, есть комментарий.Вот пример некоторого кода и недокументированного метода, где он не будет работать:

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.
    }
}
0 голосов
/ 07 августа 2015

Это начало происходить со мной время от времени с последней сборкой, Марсом.Перезапуск Eclipse исправляет это.Кажется, мне действительно нужно перезапускать Eclipse каждый день, чтобы избежать случайных проблем, подобных этой.

...