如何添加选项以在 Javadoc 注释中显示 @tags

Question

我有两个自己的注释，用于不同的字段和方法以及@Deprecated注释。但是，与@Deprecated注释不同，注释可以在带有描述的 Javadoc 注释中显示，我是否不可能用自己的注释来做到这一点。

小例子：

/**
 * Sends "bar".
 *
 * @deprecated Use {@link #sendFooBar()} instead.
 */
@Deprecated
@MyAnnotation // I want to add a description to this annotation in the comment above
public void sendBar(){
    System.out.prntln("bar");
}

所以我的问题是我必须做什么，以便在评论本身中显示注释并提供评论。

我不能只是将它添加到评论中，因为它会被视为“错误的标签”。

澄清一下：我不想只在评论中显示 @ 符号。我知道该怎么做。
我想在 Javadoc 注释中包含类似于可用于@Deprecated注释的文档（描述）。

自理有注释@Documented，@Retention(RetentionPolicy.RUNTIME)并@Target({ElementType.METHOD, ElementType.FIELD})重视他们的注释。

Answer 1

不可能按照您的想法在 javadoc 中使用自定义注释。如果您按照规范编写注释，这将变得更加明显。javadoc@deprecated 标签是小写的，而Java 语言的@Deprecated 注释是大写的。

这是因为 javadoc@deprecated标记对底层方法和/或构造函数的弃用进行了@Deprecated注释，而不是表示 Java注释本身。因此，您无法按照默认方式在 javadoc 中使用注释。

但是，可以向 javadoc 引入自定义标签。此处解释了如何执行此操作。您还可以考虑在 javadoc 注释中提及您的注释可能具有的其他含义。要安全地转义注释的名称，只需使用{@code ...}构造。