How can one use variables in JAVADOC comments?

Question

I wish to refer to a particular URL in JAVADOC comments in a project. However, I know that the URL may change in the near future. So, I was looking for a functionality that allows one to use a single variable in place of this URL throughout the project. So that if needed, it can easily be changed, but I could not find one. Is there a way to achieve this?

Accepted Answer

By looking into javadoc specification doc I see this tag : `{@value}`

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

So if you create a class for example `DocLinksHolder` and declare static fields there, then you can refer to them in javadoc.

```
{@value DocLinksHolder#fieldName}
```

How can one use variables in JAVADOC comments?

Solution

Problem

Related problems