Как можно использовать переменные в комментариях JAVADOC?

Я хочу ссылаться на конкретный URL-адрес в комментариях JAVADOC в проекте. Однако я знаю, что URL-адрес может измениться в ближайшем будущем. Итак, я искал функциональность, которая позволяет использовать одну переменную вместо этого URL-адреса во всем проекте. Чтобы это было необходимо, его можно легко изменить, но я не смог его найти.

Ответы

Ответ 1

Изучая спецификацию javadoc doc Я вижу этот тег: {@value}

Отображает значение константы, которое должно быть статическим полем.

Итак, если вы создаете класс, например DocLinksHolder, и объявляете там статические поля, вы можете ссылаться на них в javadoc.

{@value DocLinksHolder#fieldName}

Ответ 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>