[java] Javadoc을 사용하여 Enum 값에 @link하는 방법

JAVA / 글쓴이

Javadoc 1.5를 사용하여 Enumeration 값에 대한 @link를 만들 수 없습니다.

내가하고 싶은 것은 다음과 같은 Enum을 만드는 것입니다.

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
}

그런 다음 다음과 같은 링크를 사용하여 Earth 용 Javadoc을 참조하십시오.

{@link Planet.EARTH}

나도 {@link Planet#EARTH}스타일 을 시도 했지만 아무 소용이 없습니다.

이것이 가능한지 아는 사람이 있습니까?

답변

#스타일은 나를 위해 작동합니다 :

{@link Planet#EARTH}

핵심은 Planet패키지를 가져 오거나 Planet정규화해야한다는 것입니다. 즉 :

{@link com.yourpackage.Planet#EARTH}

답변

나는 이것을 확인하기 위해 Eclipse를 사용하고 있지만 

{@link Planet#EARTH}

스타일이 작동하는 것 같습니다. 그러나 나는 일반적으로

@see Planet#EARTH

어쨌든. Eclipse가 Javadoc을 생성하는 데 사용하는 것이 확실하지 않지만 JDK6을 사용하고 있습니다. 그래도 @see가 당신을 위해 트릭을 할 수도 있습니다.

답변

가져 오기만하면 연결할 수 있습니다 (하지만 이렇게하면 IMO는 가져 오기를 복잡하게 만듭니다. 코드에서 사용되는 것과 javadoc에서 사용되는 것은 무엇입니까? 완전한 이름을 사용하는 것을 좋아합니다).

하지만 예, Eclipse는 모든 것을 처리 할 수 ​​있습니다.

{@link Planet#EARTH}

잘 작동합니다.

Eclipse를 사용하는 경우 Ctrl + Shift + O (PC) 또는 Cmd + Shift + O (Mac)를 사용하여 가져 오기를 자동 조정합니다 (즉, 사용하지 않는 추가 가져 오기가있는 경우 제거되고 추가됩니다. 필요한 모든 수입품).

답변