ALTE DOCUMENTE
|
||||||
The following section explains where Doc Comment tags can be used. Note that the following tags can be used in all doc comments: @see, @link, @since, and @deprecated.
To understand where Doc Comment tags can be used, it is sometimes easier to group the 15115g616p se tags into the following: Overview Tags, Package Tags, Class/Interface Tags, Field Tags, Constructor/Method Tags. The following tables group all javadoc recognized tags.
Overview Document Tags
Overview tags are tags that can appear in the doc comment for the overview page (which resides in the source file typically named overview.html). Like in any other doc comments, these tags must appear after the description.
|
Overview Documentation Tags |
|
@see @since @author @version |
Package Document Tags
Package tags are tags that can appear in the doc comment for a package (which resides in the source file named package.html). The @serial tag can only be used here with the include or exclude argument.
|
Package Documentation Tags |
|
@see @since @deprecated @serial @author @version |
Class and Interface Documentation Tags
The following are tags that can appear in the doc comment for a class or interface. The @serial tag can only be used here with the include or exclude argument.
|
Class and Interface Documentation Tags |
|
@see @since @deprecated @serial @author @version |
Field Documentation Tags
The following are the tags that can appear in the doc comment for a field.
|
Field Documentation Tags |
|
@see @since @deprecated @serial @serialField |
Constructor and Method Documentation Tags
The following are the tags that can appear in the doc comment for a constructor or method, except for , which cannot appear in a constructor
|
Constructor and Method Documentation Tags |
|
@see @since @deprecated @param @return @throws and @exception @serialData |
|
