Вопрос по java, javadoc – Javadoc @ смотри или {@link}?

155

Может кто-нибудь сказать мне разницу между Javadoc@see а также{@link}?

Вернее, когда использовать какой из них?

Ваш Ответ

3   ответа
190

официальные рекомендации по этому довольно ясно.

Функциональные различия:

{@link} is an inline link and can be placed wherever you like @see creates its own section

По моему мнению,{@link} лучше всего использовать, когда вы буквально используете имя класса, поля, конструктора или метода в своем описании. Пользователь сможет кликнуть на javadoc того, что вы связали.

Я использую@see аннотация в 2 случаях:

Something is very relevant but not mentioned in the description. I refer to the same thing multiple times in the description, and it is used as a replacement for multiple links to the same.

Я основывал это мнение на случайной проверке документации для большого разнообразия вещей в стандартной библиотеке.

Для тех, кто ищет, вы можете получить подробную информацию об этом (включая предупреждение о@link в комментарии выше) вOracle's Javadoc guide.
Javadoc предупреждает, что @link довольно интенсивен и должен использоваться только при необходимости.
41

@see создает изолированную линию в Javadocs.{@link} для встраивания в текст.

я использую@see когда это связанный объект, но я не ссылаюсь на него в пояснительном тексте. Я использую ссылки в тексте, когда существует тесная связь, или (мне кажется), вероятно, читатель получит пользу от навигационной подсказки, например, вам нужно будет ссылаться на нее напрямую.

0

официальные документы предпочитать{@link} над@see (начиная с Java 1.2):

For Javadoc 1.2 and later, the standard format is to use @deprecated tag and the in-line {@link} tag. This creates the link in-line, where you want it. For example:

For Javadoc 1.1, the standard format is to create a pair of @deprecated and @see tags. For example:

Похожие вопросы