Login

Login
  • Register
  • VectorDesign blog

    Testing Automation and general Tech Geek stuff

    Java Doc tags

    Posted in java on 1 July 2019 by vectordesign
    TagDescriptionSyntax
    @authorAdds the author of a class.@author name-text
    {@code}Displays text in code font without interpreting the text as HTML markup or nested javadoc tags.{@code text}
    {@docRoot}Represents the relative path to the generated document’s root directory from any generated page.{@docRoot}
    @deprecatedAdds a comment indicating that this API should no longer be used.@deprecated deprecatedtext
    @exceptionAdds a Throws subheading to the generated documentation, with the classname and description text.@exception class-name description
    {@inheritDoc}Inherits a comment from the nearest inheritable class or implementable interface.Inherits a comment from the immediate surperclass.
    {@link}Inserts 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.{@link package.class#member label}
    {@linkplain}Identical to {@link}, except the link’s label is displayed in plain text than code font.{@linkplain package.class#member label}
    @paramAdds a parameter with the specified parameter-name followed by the specified description to the “Parameters” section.@param parameter-name description
    @returnAdds a “Returns” section with the description text.@return description
    @seeAdds a “See Also” heading with a link or text entry that points to reference.@see reference
    @serialUsed in the doc comment for a default serializable field.@serial field-description | include | exclude
    @serialDataDocuments the data written by the writeObject( ) or writeExternal( ) methods.@serialData data-description
    @serialFieldDocuments an ObjectStreamField component.@serialField field-name field-type field-description
    @sinceAdds a “Since” heading with the specified since-text to the generated documentation.@since release
    @throwsThe @throws and @exception tags are synonyms.@throws class-name description
    {@value}When {@value} is used in the doc comment of a static field, it displays the value of that constant.{@value package.class#field}
    @versionAdds a “Version” subheading with the specified version-text to the generated docs when the -version option is used.@version version-text

    Leave a Reply