Как связать значение Enum с помощью Javadoc - PullRequest
Новая
       13

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

104 голосов
/ 05 октября 2009

Используя Javadoc 1.5, я не смог создать @ ссылку на значение перечисления.

Что я хотел бы сделать, так это создать 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 for Earth по следующей ссылке: 

{@link Planet.EARTH}

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

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

Ответы [ 3 ]

167 голосов
/ 05 октября 2009

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

{@link Planet#EARTH}

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

{@link com.something.somethingelse.Planet#EARTH}
5 голосов
/ 05 октября 2009

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

{@link Planet#EARTH}

стиль, кажется, работает. Тем не менее, я обычно предпочитаю 

@see Planet#EARTH

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

2 голосов
/ 06 октября 2009

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

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

{@link Planet#EARTH}

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

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

...