Comment Javadoc les énumérations individuelles d'une classe

Question

J'écris le javadoc pour une classe qui contient ses propres énumérations. Existe-t-il un moyen de générer du javadoc pour les énumérations individuelles? Par exemple, en ce moment, j'ai quelque chose comme ça:

/**
 * This documents "HairColor"
 */
private static enum HairColor { BLACK, BLONDE, BROWN, OTHER, RED };

Cependant, cela ne documente que toutes les énumérations dans leur ensemble:

Existe-t-il un moyen de documenter chacune des valeurs HairColor individuellement? Sans déplacer l'énumération dans sa propre classe ou la changer d'énumération?

Merci d'avance pour votre aide.

Answer 1

Vous le faites comme n'importe quelle autre variable que vous feriez javadoc.

/**
 *  Colors that can be used
 */
public enum Color
{
    /**
     * Red color
     */
    red,

    /**
     * Blue color
     */
    blue

}

MODIFIER:

De Paŭlo Ebermann: L'énumération est une classe distincte. Vous ne pouvez pas inclure sa documentation complète dans la classe englobante (au moins, sans patcher le doclet standard).

Answer 2

Vous pouvez créer un lien vers l'élément de chaque énumération. Tous les éléments seront répertoriés dans javadocs pour énumérer la classe.

/**
 *  Colors that can be used
 *  <li>{@link #RED}</li>
 *  <li>{@link #BLUE}</li>
 */
public enum Color {

    /**
     * Red color
     */
     RED,

    /**
     * Blue color
     */
    BLUE
}