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

java javadoc

2022-09-03 15:15:58

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

有没有办法做到这一点？

答案 1

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

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

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

{@value DocLinksHolder#fieldName}

答案 2

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

有了这个在你的pom ：

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

Maven 会找到所有与 ${something} 匹配的字符串，并用来自 pom 的值替换它们。

例如，您可以将

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

和在你的绒球：

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