Как сослаться на метод в Javadoc?

Question

Как правильно использовать тег @link для ссылок на методы?

Я хочу изменить следующий код:

/**
 * Возвращает объект Baz, принадлежащий объекту Bar, который принадлежит объекту Foo,
 * который принадлежит данному объекту.
 * Удобный метод, эквивалентный getFoo().getBar().getBaz()
 * @return baz
 */
public Baz fooBarBaz()

на следующий:

/**
 * Возвращает объект Baz, принадлежащий объекту Bar, который принадлежит объекту Foo,
 * который принадлежит данному объекту.
 * Удобный метод, эквивалентный {@link getFoo()}.{@link getBar()}.{@link getBaz()}
 * @return baz
 */
public Baz fooBarBaz()

Однако я не знаю, как правильно отформатировать тег @link.

Answer 1

Вы можете использовать @see для этого:

Пример:

interface View {
        /**
         * @return true: если есть разрешения на чтение контактов и журналов вызовов, иначе - false
         * @see #requestReadContactAndCallLogPermissions()
         */
        boolean haveReadContactAndCallLogPermissions();

        /**
         * Если разрешения не предоставлены, запросить у пользователя разрешение
         * @see #haveReadContactAndCallLogPermissions()
         */
        void requestReadContactAndCallLogPermissions();
    }

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

Как сослаться на метод в Javadoc?

1 ответ(ов)

Руководство по Markdown

Форматирование текста

Код

Списки

Поддерживаемые языки программирования

Популярные

Другие .NET

Базы данных