Wie @link zu einem Enum-Wert mithilfe von Javadoc

Question

Verwenden von Javadoc 1.5 konnte ich nicht zu einem Link zu einem Enumeration-Wert erstellen.

Was würde ich tun möchte, ist eine Enum wie diese zu erstellen:

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 
} 

Und dann auf die Javadoc für die Erde beziehen Sie einen Link wie folgt aus:

{@link Planet.EARTH} 

ich versucht habe, die {@link Planet#EARTH} Stil auch, aber ohne Erfolg.

Wer weiß, ob das überhaupt machbar ist?

Answer 1

Die # Art arbeitet für mich:

{@link Planet#EARTH} 

Der Schlüssel ist, dass der Planet Paket importiert werden muss, oder Planeten muss vollständig qualifiziert sein - das heißt:

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

Answer 2

ich Eclipse-bin mit dieser zu überprüfen, aber

{@link Planet#EARTH} 

Stil scheint zu funktionieren. Normalerweise bevorzuge ich jedoch

sowieso. Ich bin mir nicht sicher, was Eclipse zum Generieren von Javadoc verwendet, aber ich verwende JDK6. Trotzdem, vielleicht macht @see den Trick für dich.

Answer 3

Solange es importiert wird Sie können es verknüpfen (aber wenn Sie dies tun, IMO macht es die Importe chaotisch - welche sind in Code und welche in Javadoc verwendet? Ich mag nur den voll qualifizierten Namen verwenden).

Aber ja, Eclipse kann darum kümmern alle und Standard

{@link Planet#EARTH} 

funktioniert gut.

Wenn Sie Eclipse, Strg + Shift + O (auf PC) oder Cmd + Shift + O (auf Mac) verwenden, passen Sie Ihre Importe automatisch an (dh wenn Sie keine zusätzlichen Importe verwenden, werden sie entfernt.) sowie das Hinzufügen von Importen, die Sie benötigen).