如何在JAVADOC评论中使用变量？

Question

我希望在项目中引用JAVADOC注释中的特定URL。但是，我知道URL可能会在不久的将来发生变化。因此，我一直在寻找一种功能，允许在整个项目中使用单个变量代替此URL。因此，如果需要，它可以很容易地改变，但我找不到一个。

有没有办法实现这个目标？

Answer 1

通过查看javadoc规范doc，我看到了这个标记：{@value}

  

显示常量的值，该值必须是静态字段。

因此，如果您创建一个类DocLinksHolder并在那里声明静态字段，那么您可以在javadoc中引用它们。

{@value DocLinksHolder#fieldName}

Answer 2

如果您使用的是maven，则可以使用其过滤功能。

将它放在你的pom中：

<resources>
  <resource>
    <directory>src/main/java</directory>
    <filtering>true</filtering>
  </resource>
</resources>

Maven将找到与$ {something}匹配的所有字符串，并将其替换为来自您的pom的值。

例如，你可以把

/**
 * URL is ${url}.
 */

在你的pom中：

<properties>
  <url>myUrl.com</url>
</properties>