Javadoc syntax relies on specific tags to guide how information is displayed in the generated documentation.
These tags can offer insights into your code’s functionality, can facilitate documentation organization, and can enable linking to other elements.
Comments written in Javadoc will be formatted based on the following tags:
@author@linkNote
As links you can have: an element name, a file, a valid web URL. If you Ctrl+right click on a link that contains an object name, it should jump to its declaration.
The element name must respect the following notations:
fully qualified names PACKAGE::CLASS.method
TYPE_NAME.INNER_TYPE_NAME or just TYPE_NAME, solved relative to the enclosing scope
@param@return@seeNote
Works similar to
@link, but it will be placed in a separate section at the bottom of the comment, named “See also”.@since@version