Java Tutorials

• @see
• @param
• @return
• @exception
• @deprecated
• @author
• @version
• @since

Javadoc comment tags

• The following special tags in Javadoc comments have predefined purposes.

@see

• Creates a link to other javadoc documentation.
• Name any identifier, but qualify it sufficiently.

    @see Attr
    @see COM.missiondata.web.utils.PageFactory;
  

@param

• Documents a single parameter to a method.
• Have one for each parameter of the method.
• First word is the parameter name, the rest is its description.

    @param max The maximum number of words to read.
  

@return

• Documents the return value of a method:

    @return The number of words actually read.
  

@exception

• Documents an exception thrown by the method.
• Should have one for each type of exception the method throws.

    @exception UnknownName The name is unknown.
    @exception IllegalArgumentException
    The name is <code>null</code>.
  

@deprecated

• Marks an identifier as being unfit for continued use.
• Code using a deprecated type, constructor, method or field will generate a warning when compiled.

     \begin{enumerate}
     \item 
     \item @deprecated Do not use this anymore.
     \item 
     \end{enumerate}
  

@author

• Specify the author of the code.

    @author Mission Data
  

@version

• Specify an arbitrary version.

    @version 1.11
  

@since

• Specify an arbitrary version specification that denotes when the tagged entity was added to your system

    @since 2.1