Javadoc - как скопировать описание функции?

Question

У меня есть две функции Java:

/**
* Do something with param
*/
public String doSomething(String param) {...};

/**
* ...
*/
public String doSomething(Integer param) {...};

Как я могу сделать описание второй функции, чтобы показать точную копию первой функции?

Answer 1

Предполагая, что копирование и вставка вам не подойдут, я считаю, что условием является использование тега @see для ссылки на другой метод, который даст более подробную информацию.

В вашем примере doSomething (целочисленный параметр) будет иметь тег @see, относящийся к версии String.

В Википедии есть несколько примеров, http://en.wikipedia.org/wiki/Javadoc

Как и сайт оракула для инструмента javadoc http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html#multiple@see

Answer 2

Короткий ответ: ты не можешь. Обычным является использование директивы @see или просто копирование вставки.

Если вы создаете подклассы, вы можете поместить Javadoc на уровень интерфейса, чтобы достичь того, чего вы хотите.

Answer 3

Поскольку два метода с разными типами params не могут иметь одинаковое описание. Но для унаследованного метода мы можем использовать то же описание.

унаследованный метод

Для наследуемого метода вы можете использовать

{@inheritDoc}

Копирует описание из переопределенного метода.

Answer 4

Ты не хочешь этого делать. Вы хотите, чтобы второй отсылал к первому. Вот для чего @see. Вы никогда не хотите повторять документацию по той же причине, по которой ваш второй метод вызывает первый метод вместо того, чтобы содержать копию его кода.