Parent issue: #19807
Coverage table
Chapter link
Content
Image
Text
@see (reference page)
Also see order of multiple @see tags.
@serial
@serialField
@serialData
(All added in Javadoc 1.2) (reference page)
For information about how to use these tags, along with an example, see "Documenting Serializable Fields and Data for a Class," Section 1.6 of the Java Object Serialization Specification. Also see Oracle's criteria for including classes in the serialized form specification.
{@link} (Added in Javadoc 1.2) (reference page)
For conventions, see Use In-Line Links Economically.
Guidelines
These chapters do not appear to contain any implementable rule. Proposal:
| Documentation Comments Rule |
Checkstyle Checks Used |
Sample files |
@see |
-- |
|
@serial |
-- |
|
@serialField |
-- |
|
@serialData |
-- |
|
{@link} |
-- |
|
Parent issue: #19807
Coverage table
Chapter link
Content
Image
Text
@see(reference page)Also see order of multiple
@seetags.@serial@serialField@serialData(All added in Javadoc 1.2) (reference page)
For information about how to use these tags, along with an example, see "Documenting Serializable Fields and Data for a Class," Section 1.6 of the Java Object Serialization Specification. Also see Oracle's criteria for including classes in the serialized form specification.
{@link}(Added in Javadoc 1.2) (reference page)For conventions, see Use In-Line Links Economically.
Guidelines
These chapters do not appear to contain any implementable rule. Proposal:
@see@serial@serialField@serialData{@link}