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

Question

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

有没有办法做到这一点？

Answer 1

通过查看 javadoc 规范文档，我看到了这个标签：{@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>