마커 인터페이스와 같은 주석 사용 Javadoc의 경우

Question

개념적으로 관련된 클래스가 몇 개 있으며 javadoc에서 이러한 클래스의 목록을 볼 수 있도록 주석을 표시하려고합니다. 여기

/** 
* Marker for the state types exposed by MyAPI 
*/ 
@Retention(RetentionPolicy.SOURCE) 
@Target(ElementType.TYPE) 
public @interface MyAPIState { 
} 

그리고 이러한 상태 중 하나입니다 :

/** 
* Stores connection state. 
*/ 
@MyAPIState 
public class ConnectionState { 
    public boolean isConnected(){...} 
} 

내가 이러한 상태에 대해 빈 마커 인터페이스 (대신 주석을 사용했다 예를 들어

는 MyAPI는 어떤 상태 변수를 제공합니다) 구현 유형을 쉽게 볼 수있었습니다. 그러나 MyAPIState 용으로 생성 된 javadoc은 주석이 첨부 된 유형에 연결하지 않습니다.

관련 형식에 대한 링크를 주석의 javadoc에 표시하도록 javadoc을 만들 수 있습니까?

Answer 1

도크 렛을 바꾸고 싶지 않다면, 내가 아는 한 javadoc에는 그러한 기능이 없습니다.

주석 대신에 사용자 정의 javadoc 태그를 사용하여이 목적으로 구현하는 사용자 정의 taglet과 결합 할 수 있습니다.

이 다음과 같이 수 :

/** 
* Marker for the state types exposed by MyAPI. 
* @linktarget 
*/ 
public interface MyAPIState { 
} 

/** 
* Stores connection state. 
* @linkfrom MyApiState 
*/ 
public class ConnectionState { 
    public boolean isConnected(){...} 
}