values - Cómo enlazar @ a un Valor Enum usando Javadoc

java enum with values

Question

Usando Javadoc 1.5, no he podido crear un enlace @ a un valor de enumeración.

Lo que me gustaría hacer es crear un Enum como este:

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
}

Y luego consulte el Javadoc for Earth usando un enlace como este:

{@link Planet.EARTH}

También probé el estilo {@link Planet#EARTH} , pero fue en vano.

Alguien sabe si esto es factible en absoluto?

Answer 1

El estilo # funciona para mí:

{@link Planet#EARTH}

La clave es que el paquete Planet debe importarse, o Planet debe estar totalmente calificado, es decir:

{@link com.something.somethingelse.Planet#EARTH}

Answer 2

Estoy usando Eclipse para verificar esto, pero

{@link Planet#EARTH}

el estilo parece funcionar. Sin embargo, normalmente prefiero

@see Planet#EARTH

de todas formas. No estoy seguro de qué usa Eclipse para generar Javadoc, pero estoy usando JDK6. Aún así, tal vez @see hace el truco para ti.

Answer 3

Mientras se importe, puedes vincularlo (pero cuando haces esto, IMO hace que las importaciones se compliquen, ¿cuáles se usan en el código y cuáles en javadoc? Me gusta simplemente usar el nombre completo).

Pero sí, Eclipse puede encargarse de todo y estándar

{@link Planet#EARTH}

funciona bien.

Si usa Eclipse, Ctrl + Shift + O (en PC) o Cmd + Shift + O (en Mac) ajusta automáticamente sus importaciones (esto significa que si tiene importaciones adicionales que no se utilizan, se eliminan, además de agregar cualquier importación que necesite).