如何在JavaDoc中包含@Annotations？

Question

我想在JavaDoc中记录一些类和方法的属性，并能够在运行时加载这些信息。因此，我认为编写一个自定义注释并在所有必要的文件和方法上注释此注释可能会很方便。使用此注释，我可以在运行时加载这些信息。

以下是一个假设代码片段，用于演示我的用例:

public class ImportantClass {
  @DetailedDescription(description="originated from data source XYZ")
  public void importantMethod() {
    // snip
  }
}

在JavaDoc中应该显示字符串"originated from data source XYZ"，并且可以通过反射或类似的方式读取。我的问题是JavaDoc不包含注释信息。

是否有可能配置JavaDoc任务（最好使用Maven）以包括注释信息？

澄清一下：我对文档注释（~javadoc annotations）不感兴趣，因为它们在运行时不可读。

- guerda

Answer 1

我终于找到了一个不重复的好方法。在注释接口（在此情况下为DetailedDescription）上使用@Documented注解，所有此注解的实例都将记录在JavaDoc中。 请参见此问题：

是否有一种方式让javadoc工具文档化注释？

- guerda

Answer 2

这更像是一条评论而不是答案，但它很长，所以我需要这种格式。

为什么你想要一个注释？根据Oracle文档的说法，在这种情况下，你应该同时使用javadoc标记和注释。从我提供的链接中可以看到：

如果您需要影响程序语义和文档，则可能需要使用注释和标记。例如，我们的指南现在建议使用@Deprecated注释来警告编译器警告，并使用@deprecated标记进行注释文本

- SJuan76

---

谢谢你的提示。我想把信息都放在一个地方，但似乎不可能。 - guerda

Answer 3

使用Javadocs，它提供了您要实现的内容。注释在代码层面上提供元数据，并旨在在应用程序的行为中发挥作用。不应该用于文档编写。

- gyorgyabraham

---

其中一个情况，这也是我提出这个问题的原因，就是使javadoc包括“相关”的元数据，例如我的情况下是JAX-RS注解，以避免重复。 - Mirvnillith