javadoc

honggarae 20/09/2022 462

Common Tag

< TD> with @throws.

Tag

Description

JDK 1.1 Doclet

Standard DOCLET < / TD>

Tag type

@Author author

author identity

√

package, class, interface

@version version number

version number

√

Pack, Class, Interface

@Param Parameter Name Description

method into the paragraph and description Information, if you have special requirements, you can comment herein.

√

Constructor, method

@return Description

Note for functions

√

method

@DEPRECated Expired Text < / TD>

Identification With the programs version, the current API has expired, only to ensure that the compatibility still exists, the developer who will not use this API again.

√

package, class, interface, value domain, constructor, method

@Throws anomaly class

Constructor or method will thrown.

√

Constructor, Method

@Exception Abnormal class name

√

Constructor, method

@see reference

View related content, such as classes, methods, variables, etc.

√

package, class, interface, value domain, constructor, method

@since Description Text

API What version of the program is supported.

√

package, class, interface, value domain, constructor, method

{@LINK package. Class # member tab}

links to a specific member corresponding to a particular member.

√

package, class, interface, value domain, constructor, method

{ @Value}

When commented on the constant, if you want to include it in the document, the value of the constant is referenced by this tag.

√ (JDK1.4)

Static Value

Also @serial , @ Serialfield, @ serialData, {@ critdoc}, {@ literal}, {@ code} {@Value arg} Several unused labels, because of not use, we do not expand narrative, Readers can view help documents.