Comment faire un @lien vers une valeur Enum en utilisant Javadoc

Question

En utilisant Javadoc 1.5, je n'ai pas réussi à créer un @lien vers une valeur d'énumération.

Ce que je voudrais faire, c'est créer un Enum comme ceci :

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
}

Et ensuite, faites référence à la Javadoc pour Earth en utilisant un lien comme celui-ci :

{@link Planet.EARTH}

J'ai essayé le {@link Planet#EARTH} aussi, mais en vain.

Quelqu'un sait-il si c'est faisable ?

Answer 1

En # Ce style me convient :

{@link Planet#EARTH}

L'essentiel est que le Planet doit être importé, ou Planet doivent être entièrement qualifiés - c'est-à-dire :

{@link com.yourpackage.Planet#EARTH}

Answer 2

J'utilise Eclipse pour le vérifier, mais

{@link Planet#EARTH}

semble fonctionner. Cependant, je préfère normalement

@see Planet#EARTH

de toute façon. Je ne sais pas ce qu'Eclipse utilise pour générer la Javadoc, mais j'utilise le JDK6. Néanmoins, @see peut peut-être faire l'affaire pour vous.

Answer 3

Tant qu'il est importé, vous pouvez le lier (mais quand vous faites cela, IMO, cela rend les importations désordonnées - quelles sont celles qui sont utilisées dans le code et celles qui sont dans la javadoc ? Je préfère simplement utiliser le nom pleinement qualifié).

Mais oui, Eclipse peut s'occuper de tout cela et la norme

{@link Planet#EARTH}

fonctionne bien.

Si vous utilisez Eclipse, les touches Ctrl + Shift + O (sur PC) ou Cmd + Shift + O (sur Mac) permettent d'ajuster automatiquement vos importations (ce qui signifie que si vous avez des importations supplémentaires non utilisées, elles sont supprimées, et que vous ajoutez toutes les importations dont vous avez besoin).