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.
I’ve noticed that Eclipse automatically adds an @author tag with my name at the top of a new Java class. I also noticed that there are other tags available like @version, @link, @code, @value, @see…
Is it just another ‘convention’ that has formed so that code remains well-documented? Or is there some other purpose?
I tried finding a website that would give better descriptions of the tags and their usage, but I didn’t have any luck.
These are Javadoc tags related to the Javadoc mechanism. When you’ll generate the Javadoc (there’s an option in the Eclipse menu for that), those link will be interpreted appropriately and the Javadoc will be better detailed. See the link in the comment for the list of all available tags.
Underestimate the power of documentation you will not.