What are the difference Between javadoc @see and {@link} ?
The functional differences are:
{@link}
is an inline link and can be placed wherever you like to place.@see
creates its own section.@see
creates an isolated line in the Javadocs.{@link}
is for embedding within text.
According to officail Documentation, {@link}
is best used when you literally use a class, field, constructor or method name in your description. The user will be able to click through to the javadoc of what you’ve linked.
And @see
annotation can be used in 2 cases:
- Something is very relevant but not mentioned in the description.
- When you want to refer the same thing multiple times in the description, and it is used as a replacement for multiple links to the same.
For more information : Official Documentation