Как ссылаться на другой метод того же класса в Джавадоке?
Предположим, что ваш класс имеет 2 метода:
contains() and
containsSame()
Различие между ними тонкое, и вы хотели бы упомянуть его как часть Javadoc
В Javadoc, как вы можете ссылаться на метод в том же классе, по имени?
Ответ 1
Используйте тег @link inline и обратитесь к методу с ведущим #.
/**
* ...
* This method is similar to {@link #contains()}, with the following differences:
* ...
*/
public boolean containsSame();
/**
* This method does ...
*/
public boolean contains();
Этот пример работает только в том случае, если на самом деле существует метод contains(), у которого нет аргументов (что, на самом деле, не так полезно). Если у вас есть только метод contains с аргументами, то либо записывайте типы аргументов в круглые скобки:
/**
* ...
* This method is similar to {@link #contains(Element)}, with the following differences:
* ...
*/
public boolean containsSame(Element e);
/**
* This method does ...
*/
public boolean contains(Element e);
Или вы можете вообще опустить круглые скобки:
/**
* ...
* This method is similar to {@link #contains}, with the following differences:
* ...
*/
public boolean containsSame(Element e);
/**
* This method does ...
*/
public boolean contains(Element e);
Если у вас есть несколько методов с именем contains (с разными списками параметров), эта версия не может решить, какой из них использовать (ссылка будет переходить на любую из них, надеюсь, что все они вместе и делают подобные вещи).