Level 189 Level 191
Level 190

[No Typing] Documentation

20 words 0 ignored

Ready to learn       Ready to review

Ignore words

Check the boxes below to ignore/unignore words, then click save at the bottom. Ignored words will never appear in any learning session.

All None

/** documentation */
This is a documentation comment and in general its called doc comment. TheJDK javadoc tool uses doc comments when preparing automatically generated documentation.
a tool which comes with JDK and it is used for generating Java code documentation in HTML format from Java source code which has required documentation in a predefined format.
Adds the author of a class.
Displays text in code font without interpreting the text as HTML markup or nested javadoc tags.
Represents the relative path to the generated document's root directory from any generated page
Adds a comment indicating that this API should no longer be used.
Adds a Throws subheading to the generated documentation, with the class-name and description text.
Inherits a comment from the nearest inheritable class or implementable interface
Inserts an in-line link with visible text label that points to the documentation for the specified package, class or member name of a referenced class. T
Identical to {@link}, except the link's label is displayed in plain text than code font.
Adds a parameter with the specified parameter-name followed by the specified description to the "Parameters" section.
Adds a "Returns" section with the description text.
Adds a "See Also" heading with a link or text entry that points to reference.
Used in the doc comment for a default serializable field.
Documents the data written by the writeObject( ) or writeExternal( ) methods
Documents an ObjectStreamField component.
Adds a "Since" heading with the specified since-text to the generated documentation.
the @throws and @exception tags are synonyms.
When {@value} is used in the doc comment of a static field, it displays the value of that constant:
Adds a "Version" subheading with the specified version-text to the generated docs when the -version option is used.