Documentation Comments - Beginning Java 8 Fundamentals - page 733

Table B-2. The Effects of Using One and Multiple @author Tags in Documentation Comments

Documentation Comment Generated Author Entry

/**
* A dummy class.
*
* @author Kishori Sharan
*/

Author :
Kishori Sharan

/**
* A dummy class.
*
* @author Kishori Sharan
* @author Greg Langham
* @author John Jacobs
*/

Author :
Kishori Sharan, Greg Langham, John Jacobs

@deprecated <explanation-text>
The @deprecated tag is used to generate documentation for program elements that should no longer be used,
although they may function correctly. The explanation text for this tag should explain why the program element
should not be used. If there is a replacement for the deprecated program element, the explanation text should contain
a link to or explanation about the replacement. The following documentation comment uses the @deprecated tag for
the Dummy class. It provides a link to Dummy2 class, which is the replacement class.

/**
* A dummy class.
*
* @deprecated As of version 1.1. Use {@link com.jdojo.utility.Dummy2 Dummy2} instead.
*/
public class Dummy {
}

@exception <class-name> <description>
The @exception tag is a synonym for @throws tag. Please refer to the description of the @throws tag for details.

@param <parameter-name> <description>
The @param is applicable only to classes, methods, and constructors. It generates a Parameters section with the
specified parameter-name and the description . If the parameter is a type parameter, the specified parameter-name
should be enclosed in angle brackets ( <> ). The following is an example of using the @param tags to document the
parameters of a method:

/**
* Returns the result of multiplication of <code>n1</code> and
* <code>n2</code>. It may return incorrect result if the value of
* the multiplication of <code>n1</code> and <code>n2</code> exceeds
* the range of the <code>int</code> data type.
*