web-dev-qa-db-fra.com

Comment @lier à une valeur énumérée à l'aide de Javadoc

À l'aide de Javadoc 1.5, je n'ai pas pu créer un @link 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 puis référez-vous au Javadoc pour la Terre en utilisant un lien comme celui-ci:

{@link Planet.EARTH}

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

Quelqu'un sait si c'est faisable du tout?

javajavadoc
109
Christer Fahlgren

Le style # fonctionne pour moi:

{@link Planet#EARTH}

La clé est que le package Planet doit être importé, ou la planète doit être pleinement qualifiée - à savoir:

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

J'utilise Eclipse pour vérifier cela, mais

{@link Planet#EARTH}

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

@see Planet#EARTH

en tous cas. Je ne sais pas ce qu'Eclipse utilise pour générer Javadoc, mais j'utilise JDK6. Pourtant, @see fait peut-être l'affaire pour vous.

5
sfussenegger

Tant qu'il est importé, vous pouvez le lier (mais lorsque vous faites cela, l'OMI rend les importations en désordre - celles qui sont utilisées dans le code et celles en javadoc? J'aime simplement utiliser le nom complet).

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

{@link Planet#EARTH}

fonctionne bien.

Si vous utilisez Eclipse, Ctrl + Shift + O (sur PC) ou Cmd + Shift + O (sur Mac) ajuste automatiquement vos importations (cela signifie que si vous avez des importations supplémentaires non utilisées, elles sont supprimées, ainsi que l'ajout toutes les importations dont vous avez besoin).

2
Jack