在 Javadoc 中使用类似标记接口的注解答案

【问题标题】：Using Annotations Like Marker Interfaces For Javadoc在 Javadoc 中使用类似标记接口的注解
【发布时间】：2011-07-30 13:48:08
【问题描述】：

我有一些概念上相关的类，想用注释标记它们，以便我可以在 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中显示相关类型的链接吗？

【问题讨论】：

标签： annotations javadoc

【解决方案1】：

据我所知，javadoc没有这样的功能，如果你不想替换doclet的话。

您可以尝试使用自定义 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(){...}
}

【讨论】：