Javadoc - как скопировать описание функции?
У меня есть две функции Java:
/**
* Do something with param
*/
public String doSomething(String param) {...};
/**
* ...
*/
public String doSomething(Integer param) {...};
Как я могу сделать второе описание функции для отображения точной копии первой функции?
Ответы
Ответ 1
Предполагая, что копирование и вставка не сработают для вас, я считаю, что соглашение должно использовать тег @see для ссылки на другой метод, который даст более подробную информацию.
В вашем примере doSomething (Integer param) будет иметь тег @see, ссылающийся на версию String.
В Википедии есть несколько примеров, http://en.wikipedia.org/wiki/Javadoc
Как и сайт оракула для инструмента javadoc http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html#[email protected]
Ответ 2
Короткий ответ: вы не можете. Обычным является использование директивы @see или просто копирование вставки.
Если вы являетесь подклассом, вы можете поместить javadoc на уровень интерфейса вместо того, чтобы достичь того, чего хотите.
Ответ 3
Поскольку два метода с разными параметрами типа не могут иметь одно и то же описание.
Но для унаследованного метода мы можем использовать одно и то же описание.
унаследованный метод
Для унаследованного метода u можно использовать
{@inheritDoc}
Он копирует описание из переопределенного метода.
Ответ 4
Вы не хотите этого делать. Вы хотите, чтобы второй ссылался на первый. Это то, что @see для. Вы никогда не хотите повторять документацию по той же причине, что ваш второй метод вызывает первый метод вместо того, чтобы содержать копию его кода.
