java如何在JAVADOC注释中使用变量？

Question

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

有没有办法做到这一点

Answer 1

如果您使用的是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> 

Answer 2

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

Displays the value of a constant, which must be a static field.

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

{@value DocLinksHolder#fieldName}