Skip to content
𝓒π“ͺ𝓼𝓽𝓻𝓲𝓳π“ͺ

Share the knowledge

𝓒π“ͺ𝓼𝓽𝓻𝓲𝓳π“ͺ

Share the knowledge

List of JavaDoc tags

Posted on February 25, 2015September 25, 2021 By sastrija

Java support different JavaDoc tags for documentation. Refer below table for details.

TagAvailable fromUse
@author1.0To mention author name of the class
@deprecated1.0To notify that a given API is no longer supported and shouldn’t be used anymore
@exception1.0To add Throws subheading to the generated documentation, wit classname & description
@param1.0Parameter with the specified parameter-name followed by the specified description to Parameters section
@return1.0Used in method level comments to describe value it returns
@see1.0Adds a “See Also” heading with a link or text entry that points to reference
@throws1.0Used to describe exceptions which a method throws from it
@since1.1Adds a “Since” heading to mention from which release this change is available
{@link}1.2Inserts an in-line link with the visible text label that points to the documentation for the specified package, class, or member name of a referenced class
@serial1.2Used in the doc comment for a default serializable field
@serialData1.2Documents the data written by the writeObject( ) or writeExternal( ) methods
@serialField1.2Documents an ObjectStreamField component
{@docRoot}1.3Relative path to generated document’s root directory from any generated page
{@inheritDoc}1.4Inherits a comment from the nearest inheritable class or implementable interface
{@linkplain}1.4Similar to {@link}, except label is displayed in plain text than code font
{@value}1.4Used to displays the value of constants
{@code}1.5To display code snippet inside comment block
{@literal}1.5It is used to denote literal text

Related

Uncategorized

Post navigation

Previous post
Next post
©2026 𝓒π“ͺ𝓼𝓽𝓻𝓲𝓳π“ͺ | WordPress Theme by SuperbThemes