[java] 클래스의 개별 열거 형을 Javadoc하는 방법

Program / 글쓴이

자체 열거 형을 포함하는 클래스에 대한 javadoc을 작성하고 있습니다. 개별 열거 형에 대해 javadoc을 생성하는 방법이 있습니까? 예를 들어, 지금은 다음과 같습니다.

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

그러나 이것은 모든 열거 형을 전체적으로 문서화합니다.

생성 된 Javadoc

각 HairColor 값을 개별적으로 문서화하는 방법이 있습니까? 열거 형을 자체 클래스로 이동하거나 열거 형에서 변경하지 않고?

도움을 주셔서 미리 감사드립니다.

답변

다른 변수와 마찬가지로 javadoc을 수행합니다.


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

    /**
     * Blue color
     */
    blue

}

편집하다:

Paŭlo Ebermann에서 : 열거 형은 별도의 클래스입니다. 포함하는 클래스에 전체 문서를 포함 할 수 없습니다 (적어도 표준 doclet 패치없이).

답변

각 열거 형 항목에 대한 링크를 만들 수 있습니다. 모든 항목은 클래스를 열거하기 위해 javadocs에 나열됩니다.

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

    /**
     * Red color
     */
     RED,

    /**
     * Blue color
     */
    BLUE
}

답변