Как Javadoc индивидуальные перечисления класса

Я пишу javadoc для класса, который содержит его собственный перечислений. Есть ли способ создать javadoc для отдельных перечислений? Например, прямо сейчас у меня есть что-то вроде этого:

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

однако это только документирует все перечисления в целом:

есть ли способ документировать каждое из значений HairColor индивидуально? Без перемещения перечисления в свой собственный класс или изменения его из перечисления?

заранее спасибо за любую помощь.

2 63
javascript enums javadoc

2 ответа:

вы делаете это так же, как и любая другая переменная, которую вы бы javadoc.


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

    /**
     * Blue color
     */
    blue

}

EDIT:

от Paŭlo Ebermann : перечисление-это отдельный класс. Вы не можете включить его полную документацию в класс enclosing (по крайней мере, без исправления стандартного доклета).

74

вы можете создать ссылку на каждый элемент перечисления. Все элементы будут перечислены в javadocs для перечисления класса.

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

    /**
     * Red color
     */
     RED,

    /**
     * Blue color
     */
    BLUE
}
48