What is the @linkplain tag used for and how does it differ from @link

Question

I am wondering what exactly is the difference of the JavaDoc tags @link and @linkplain.

They both seem to generate the same html code.

score 39 · Accepted Answer · edited Nov 17 '22 at 06:35

39

It produces different formatting in javadoc you can try it in IDE:

{@link #method()} - monospaced formatting (code)

{@linkplain #method()} standard formatting

Example:

edited Nov 17 '22 at 06:35

srk

4,857
12
65
109

answered Mar 13 '18 at 12:55

Maciej

1,954
10
14

2

you are right, the font is different. In my IDE this difference is almost not noticeable. – kerner1000 Mar 13 '18 at 13:37

score 26 · Answer 2 · answered Jun 05 '18 at 11:38

From Oracle documentations:

@link

Inserts an in-line link with visible text label that points to the documentation for the specified package, class or member name of a referenced class. This tag is valid in all doc comments: overview, package, class, interface, constructor, method and field, including the text portion of any tag (such as @return, @param and @deprecated).

@linkplain

Identical to {@link}, except the link's label is displayed in plain text than code font. Useful when the label is plain text.

What is the @linkplain tag used for and how does it differ from @link

2 Answers2