對Javadoc使用類似標記接口的註釋

Question

我有一些概念上相關的類，並希望用註釋標記它們，以便我可以在javadoc中看到這些類的列表。

例如，MyAPI提供一些狀態變量：

/** 
* 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(){...} 
} 

如果我用於這些狀態的空標誌接口（而不是註解）我會很容易地看到實現類型。但生成的MyAPIState的javadoc並不鏈接到使用它註釋的類型。

我可以讓javadoc顯示註釋的javadoc中相關類型的鏈接嗎？

Answer 1

據我所知，如果你不想替換doclet，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(){...} 
}