IT story

Javadoc을 사용하여 @um 값에 연결하는 방법

hot-time 2020. 8. 2. 17:17
반응형

Javadoc을 사용하여 @um 값에 연결하는 방법


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
}

그리고 다음 링크를 사용하여 Javadoc for Earth를 참조하십시오.

{@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)는 가져 오기를 자동으로 조정합니다 (이는 가져 오기를 사용하지 않는 추가 가져 오기가있는 경우 제거 및 추가 함을 의미 함) 필요한 수입품).

참고 URL : https://stackoverflow.com/questions/1521239/how-to-link-to-a-enum-value-using-javadoc

반응형