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

使用注释像Javadoc的标记接口

1 个答案: