Could someone tell me the difference between javadoc @see and {@link}?
Or rather, when to use which of them?
Sign Up to our social questions and Answers Engine to ask questions, answer people’s questions, and connect with other people.
Login to our social questions & Answers Engine to ask questions answer people’s questions & connect with other people.
Lost your password? Please enter your email address. You will receive a link and will create a new password via email.
Please briefly explain why you feel this question should be reported.
Please briefly explain why you feel this answer should be reported.
Please briefly explain why you feel this user should be reported.
The official guidelines on this are pretty clear.
The functional differences are:
{@link}is an inline link and can be placed wherever you like@seecreates its own sectionIn my opinion,
{@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.I use the
@seeannotation in 2 cases:I based this opinion on randomly checking out documentation for a great variety of things in the standard library.