Eclipse добавить неосуществленные методы, включая Javadoc

Question

При реализации интерфейса в eclipse у него есть действительно хорошая функция, которая позволяет вам «добавлять нереализованные методы», и он генерирует заглушки для методов интерфейса.

Однако, он не привел документацию метода из методов интерфейса, и мне было интересно, есть ли способ получить затмение, чтобы сделать это.

Вот что я хочу, чтобы произошло. Допустим, у меня был такой интерфейс:

public interface BaseInterface {

    /**
     * This method takes the given string parameter and returns its integer value.
     * 
     * @param x the string to convert
     * @return the integer value of the string
     * 
     * @throws Exception if some error occurs
     */
    int method1(String x);
}

Теперь я создаю класс MyClass, который реализует этот интерфейс. Я хочу, чтобы, когда я сказал «Не реализованные методы», я хотел, чтобы мой код выглядел следующим образом:

public class MyClass implements BaseInterface {

    /**
     * This method takes the given string parameter and returns its integer value.
     * 
     * @param x the string to convert
     * @return the integer value of the string
     * 
     * @throws Exception if some error occurs
     */
    public int method1(String x) {
        return 0;
    }

}

Answer 1

Да: эти методы генерируются с использованием шаблонов кода, которые вы написали.

Вам нужно будет перейти в «Окно / Настройки -> Java / Стиль кода / Шаблоны кода»

Затем в списке выберите «Комментарии / методы переопределения» и измените содержимое на содержимое, найденное в «Комментарии / методы»:

/**
 * ${tags}
 */

Вы даже можете подумать о добавлении ${see_to_overridden}, чтобы иметь прямую ссылку на оригинальный метод. Однако обратите внимание, что метод без javadoc автоматически наследует свой javadoc от переопределенного, поэтому такой шаблон может генерировать менее релевантный документ, чем поведение по умолчанию.

Answer 2

Вы можете достичь этого с помощью аннотации JavaDoc. Он не специфичен для Eclipse и будет работать во всех инструментах генерации сборки / документации:

/**
 * My custom decumentation, and then the original one:
 * 
 * {@inheritDoc}
 */