클래스의 개개의 에넘을 자바독하는 방법

클래스의 개개의 에넘을 자바독하는 방법

자체 에넘이 포함된 클래스의 Javadoc을 작성하고 있습니다.개별 Enum에 대해 Javadoc을 생성하는 방법이 있습니까?예를 들어, 지금 저는 다음과 같은 것을 가지고 있습니다.

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

다만, 이것은 모든 에넘을 전체적으로 문서화하는 것에 지나지 않습니다.

각각의 정보를 문서화할 수 있는 방법이 있습니까?HairColor개별적인 가치관열거형을 자체 클래스로 이동하거나 열거형에서 변경하지 않고?

javadoc할 수 있는 다른 변수와 동일하게 수행합니다.

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

    /**
     * Blue color
     */
    blue

}

편집:

From Pa'lo Ebermann : 열거형은 다른 클래스입니다.적어도 표준 문서에 패치를 적용하지 않고는 해당 문서의 전체 문서를 동봉 클래스에 포함할 수 없습니다.

각 열거형 항목에 대한 링크를 생성할 수 있습니다.모든 항목이 javadocs to enum 클래스에 나열됩니다.

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

    /**
     * Red color
     */
     RED,

    /**
     * Blue color
     */
    BLUE
}

@see anotation과 함께

 /**
 *  Colors that can be used
 *  @see #RED
 *  @see #BLUE
 */
public enum Color {

    /**
     * Red color
     */
     RED,

    /**
     * Blue color
     */
    BLUE
}

언급URL : https://stackoverflow.com/questions/6549821/how-to-javadoc-a-classs-individual-enums