Javadoc tags

I am going to explain frequently used tags provided by java. Javadoc tool parses these tags, when they are embedded in Javadoc comments.

Tags starts with @ sign.

Ex:

@param

@since

@return

@author

Is tags are case sensitive?

Yes

Tags are categorized into two types

Block tags: Place block tags only in the tag section that follows the description. Block tags have the form: @tag.

Inline tags: Place inline tags anywhere in the main description or in the comments for block tags. Inline tags are enclosed within braces: {@tag}.

Following are the block tags that I used frequently

@author

@deprecated

@exception

@param

@return

@see

@serial

@since

@throws

@version

Following are the inline tags that I used frequently

{@inheritDoc}

{@link}

{@value}

Reference

https://docs.oracle.com/javase/8/docs/technotes/tools/windows/javadoc.html#CHDJGIJB

Previous                                                 Next                                                 Home