Как использовать @link для значения Enum с помощью Javadoc

Используя Javadoc 1.5, мне не удалось создать @link для значения Enumeration.

Что бы я хотел сделать, так это создать Enum следующим образом:

public enum Planet { 

/**
* MERCURY is a fun place.
*/
MERCURY, 

/**
* VENUS is more fun.
*/
VENUS, 

/**
* But nothing beats the Earth.
*/
EARTH,

/**
* Others we know nothing about.
*/ 
OTHERS
}

И затем обратитесь к Javadoc для Земли, используя следующую ссылку:

{@link Planet.EARTH}

Я тоже пробовал стиль {@link Planet#EARTH}, но безрезультатно.

Кто-нибудь знает, действительно ли это выполнимо?

Ответы

Ответ 1

Стиль # работает для меня:

{@link Planet#EARTH}

Ключ в том, что пакет Planet должен быть импортирован, или Planet должен быть полностью квалифицирован, т.е.

{@link com.yourpackage.Planet#EARTH}

Ответ 2

Я использую Eclipse, чтобы проверить это, но

{@link Planet#EARTH}

Стиль

похоже, работает. Тем не менее, я обычно предпочитаю

@see Planet#EARTH

в любом случае. Не уверен, что Eclipse использует для генерации Javadoc, но я использую JDK6. Тем не менее, возможно, @see делает трюк для вас.

Ответ 3

Пока он импортируется, вы можете связать его (но когда вы это делаете, IMO делает импорт грязным - какие используются в коде и какие в javadoc? Мне нравится просто использовать полное имя).

Но да, Eclipse может позаботиться обо всем этом и стандартном

{@link Planet#EARTH}

отлично работает.

Если вы используете Eclipse, Ctrl + Shift + O (на ПК) или Cmd + Shift + O (на Mac), автоматически настраивайте импорт (это означает, что если у вас есть дополнительный импорт, который не используется, они удаляются, так как а также добавление необходимых им импортных данных).