Посилання Javadoc на метод в іншому класі

В даний час я посилаюсь на методи в інших класах із цим синтаксисом Javadoc:

@see {@link com.my.package.Class#method()}

І з того, що я розумію з документації, це правильний спосіб зробити це. Але тепер до кумедної частини, або розчарування. Коли я генерую цей javadoc, я, перш за все, отримую наступну помилку:

warning - Tag @see:illegal character: "123" in "{@link com.my.package.Class#method()}"
warning - Tag @see:illegal character: "64" in "{@link com.my.package.Class#method()}"
warning - Tag @see: reference not found: {@link com.my.package.Class#method()}

Створений HTML-код цього:

"," <code>com.my.package.Class#method()}</code> ","

І звичайно у мене немає зв’язку. Хтось може сказати мені, що відбувається, і будь-які підказки, як це виправити?

Згідно з таблицями ASCII таблиці 123 і 64 для wold представляють {і @, то чому вони не є дійсними, коли цей синтаксис є правильним згідно з документацією?

Для тегу Javadoc @seeне потрібно використовувати @link; Javadoc створить для вас посилання. Спробуйте

@see com.my.package.Class#method()

Ось більше інформації про @see.

Крім @seeзагального способу переходу до іншого класу та, можливо, методу цього класу є {@link somepackage.SomeClass#someMethod(paramTypes)}. Це має перевагу в тому, що можна використовувати в середині опису javadoc.

З документації на javadoc (опис тегу @link) :

Цей тег дуже схожий на @see - обидва вимагають однакових посилань і приймають абсолютно однаковий синтаксис для Packa.class # члена та мітки. Основна відмінність полягає в тому, що {@link} створює поточне посилання, а не розміщувати посилання в розділі "Дивіться також". Також тег {@link} починається і закінчується фігурними дужками, щоб відокремити його від решти рядкового тексту.

Тож рішення вихідної проблеми полягає в тому, що вам не потрібні посилання "@see" та "{@link ...}" в одному рядку. Тег "@link" є самодостатнім, і, як зазначалося, ви можете розмістити його будь-де в блоці javadoc. Таким чином, ви можете змішати два підходи:

/**
 * some javadoc stuff
 * {@link com.my.package.Class#method()}
 * more stuff
 * @see com.my.package.AnotherClass
 */