I'm looking for better ways to document my code in Netbeans.
In addition to the tags known and used a> in the Javadoc something caught my attention and piqued my curiosity.
When typing {@ some suggestions for documentation with tags appear that I have never seen and that I do not know what it is for. Some:
{@code}
{@docRoot}
{@link}
{@linkplain}
{@literal}
Would {@link} be a replacement of the @link tag? What are these other tags for?
You can get a list of the top tags of Javadoc on Wikipedia or you can get official documentation .
*Usuallythetagthrowsispreferredwhenthemethoda checked exception .
These are the recommendations. Obviously you can use it however you want. Many people do not like using certain tags that do not add relevant information to the documentation. Author is the most obvious of them. Authoring control and creation date should be controlled by version control software. But it depends on the culture of each team.