18.4.3

The

@version

 Tag

DOCUMENTATION COMMENTS

18.4.3   The

@version

 Tag

The following is an example of a

@version

 paragraph, which may be used in doc 

umentation comments for class and interface declarations:

@version 493.0.1beta

The information in a

@version

 paragraph has no special internal structure.

A documentation comment may contain at most one

@version

 tag.

18.4.4   The

@param

 Tag

The following are examples of

@param

 paragraphs, which may be used in docu 

mentation comments for method and constructor declarations:

@param file the file to be searched

@param pattern

the pattern to be matched during the search

@param count

the number of lines to print for each match

The information in a

@param

 paragraph should consist of the name of the

parameter followed by a short description.

A documentation comment may contain more than one

@param

 tag. The usual

convention is that if any

@param

 paragraphs are present in a documentation com 

ment, then there should be one

@param

 paragraph for each parameter of the

method or constructor, and the

@param

 paragraphs should appear in the order in

which the parameters are declared.

18.4.5   The

@return

 Tag

The following is an example of a

@return

 paragraph, which may be used in doc 

umentation comments for declarations of methods whose result type is not

void

:

@return the number of widgets that pass the quality test

The information in a

@return

 paragraph has no special internal structure. The

usual convention is that it consists of a short description of the returned value.

A documentation comment may contain at most one

@return

 tag.

18.4.6   The

@exception

 Tag

The following is an example of an

@exception

 paragraph, which may be used in

documentation comments for method and constructor declarations:

422