Как сослаться на другой метод того же класса в Javadoc?
У меня есть класс с двумя методами:
contains() и
containsSame()
Различие между этими методами тонкое, и я хотел бы упомянуть об этом в Javadoc.
Как в Javadoc можно сослаться на метод в том же классе по имени?
1 ответ(ов)
Чтобы привести пример использования тега @link в JavaDoc, нужно ссылаться на метод, добавив символ # перед его именем.
/**
* ...
* Этот метод похож на {@link #contains()}, с учетом следующих отличий:
* ...
*/
public boolean containsSame();
/**
* Этот метод выполняет ...
*/
public boolean contains();
Этот пример будет работать только в том случае, если действительно есть метод contains(), который не принимает аргументов (что, на самом деле, может быть не очень полезно). Если у вас есть только метод contains, принимающий аргументы, то вы можете указать типы аргументов в скобках:
/**
* ...
* Этот метод похож на {@link #contains(Element)}, с учетом следующих отличий:
* ...
*/
public boolean containsSame(Element e);
/**
* Этот метод выполняет ...
*/
public boolean contains(Element e);
Либо вы можете полностью опустить скобки:
/**
* ...
* Этот метод похож на {@link #contains}, с учетом следующих отличий:
* ...
*/
public boolean containsSame(Element e);
/**
* Этот метод выполняет ...
*/
public boolean contains(Element e);
Если у вас имеется несколько методов с именем contains (с различными параметрами), то данная версия не сможет определить, на какой из них нужно ссылаться (ссылка будет вести на любой из них, надеемся, они все находятся рядом и выполняют схожие функции).
Как сослаться на метод в Javadoc?
Пример кода с несколькими строками в комментарии Javadoc
Почему в javadoc Double.valueOf указано, что значения кэшируются, если это не так?
JavaDoc: где добавлять заметки/пояснения в документацию?
Инициализация ArrayList в одну строчку