Templates

Lets you define templates to be inserted for the different declaration elements when Javadoc Generation (see the section called “Generation”) has been enabled. Each element (Class, Interface, Field, Constructor and Method) has its own template. Depending on the element type, a template consists of up to five parts that together form a valid Javadoc comment. When Javadoc formatting (see the section called “Format”) is enabled, the templates will be reformatted before they are inserted.

You can use variable expressions throughout your templates to insert various data automagically. See the section called “Local variables” for more information about the available variables.

Important

The templates also describe the formatting style for each element and are used to determine the description texts that are to be inserted for the Javadoc auto-correction feature (described in the section called “Correction”).

Class template

Lets you define the template for class and enum declarations (including inner classes).

Figure 2.73. Javadoc class template

Javadoc class template

Enter a valid Javadoc comment. The Preview window will update in real-time to reflect your changes.

Example 2.851. Class declaration with generated Javadoc

/**
 * DOCME!
 *
 * @author $author$
 * @version $Revision: #22 $, $Date: 2007/08/15 $
 */
public class CompilationUnit {
}