Editing Javadoc (section)

== Tags ==
{{Update|section|inaccurate=yes|reason=Should be updated according to the [https://docs.oracle.com/en/java/javase/21/docs/specs/javadoc/doc-comment-spec.html official documentation]|date=November 2023}}
Some of the available Javadoc tags<ref>[https://docs.oracle.com/en/java/javase/13/docs/specs/javadoc/doc-comment-spec.html JavaSE 13 Documentation Comment Specification]</ref> are listed in the table below:

{| class="wikitable"
!Syntax
!Usage
!Applies to
!Since
|-
|'''@author''' ''name''|| Identifies the 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''|| Version information || Module, Package, Class, Interface, Enum ||
|-
|'''@since''' ''since-text''|| Describes when this functionality first existed || Class, Interface, Enum, Field, Method||
|-
|'''@see''' ''reference''|| Links 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''|| Marks the 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; equivalent to '''<code>{@literal}</code>''' || Class, Interface, Enum, Field, Method||1.5.0
|-
|{'''@literal''' ''literal''}|| Denotes literal text; the enclosed text is interpreted as not containing HTML markup or nested javadoc tags || Class, Interface, Enum, Field, Method||1.5.0
|-
|{'''@serial''' ''literal''}
|Denotes a default serializable field
|Field
|
|-
|{'''@serialData''' ''literal''}
|Denotes data written by the writeObject( ) or writeExternal( ) methods
|Field, Method
|
|-
|{'''@serialField''' ''literal''}
|Denotes an ObjectStreamField component
|Field
|
|}