Javadoc: Difference between revisions

Revision as of 14:30, 6 January 2025

Revision as of 14:39, 6 January 2025

Line 110:

{| class="wikitable"

!Syntax

!Tag & Parameter

!Usage

!Applies to

!Since

|-

|'''@author''' ''John Smithname''|| DescribesIdentifies anthe author. such as "Pat Smith" || Class, Interface, Enum ||

|-

|{'''@docRoot'''}

|Represents the relative path to the generated document's root directory from any generated page.

|Class, Interface, Enum, Field, Method

|

|-

|'''@version''' ''version''|| Provides software versionVersion information. || Module, Package, Class, Interface, Enum ||

|-

|'''@since''' ''since-text''|| Describes when this functionality has first existed. || Class, Interface, Enum, Field, Method||

|-

|'''@see''' ''reference''|| Provides a linkLinks to other element of documentation. || Class, Interface, Enum, Field, Method||

|-

|'''@param''' ''name description''|| Describes a method parameter. || Method||

|-

|'''@return''' ''description''|| Describes the return value. || Method||

|-

|'''@exception''' ''classname description''<br />'''@throws''' ''classname description''|| Describes an exception that may be thrown from this method.|| Method||

|-

|'''@deprecated''' ''description''|| DescribesMarks an outdatedthe method. as outdated || Class, Interface, Enum, Field, Method||

|-

|{'''@inheritDoc'''}||Copies the description from the overridden method.||Overriding Method||1.4.0

|-

|{'''@link''' ''<var>reference</var>''}||Link to other symbol.||Class, Interface, Enum, Field, Method||

|-

|{'''@linkplain''' ''<var>reference</var>''}

|Identical to {@link}, except the link's label is displayed in plain text than code font.

|Class, Interface, Enum, Field, Method

|

|-

|{'''@value''' ''#STATIC_FIELD''}|| Return the value of a static field.||Static Field||1.4.0

|-

|{'''@code''' ''literal''}|| Formats literal text in the code font. It is; equivalent to <nowiki>'''<code>{@literal}</code></nowiki>.''' || Class, Interface, Enum, Field, Method||1.5.0

|-

|{'''@literal''' ''literal''}|| Denotes literal text.; Thethe enclosed text is interpreted as not containing HTML markup or nested javadoc tags. || Class, Interface, Enum, Field, Method||1.5.0

|-

|{'''@serial''' ''literal''}

|Used in the doc comment forDenotes a default serializable field.

|Field

|

|-

|{'''@serialData''' ''literal''}

|Documents theDenotes data written by the writeObject( ) or writeExternal( ) methods.

|Field, Method

|

|-

|{'''@serialField''' ''literal''}

|DocumentsDenotes an ObjectStreamField component.

|Field

|