Templates

Lets you define templates to be inserted for the different declaration elements. 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.

Please note that the templates also describe the style of Javadoc formatting for each element and are used to determine the description texts that are to be inserted for the Javadoc auto-correction feature (see the section called "Correction").

You can use variable expressions throughout your templates. See the section called "Local variables" for more information about the available variables.

Class template

Figure 2.72. Javadoc class template

Javadoc class template

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

Example 2.822. Class declaration with generated Javadoc

/**
 * DOCME!
 *
 * @author $author$
 * @version $Revision: #21 $, $Date: 2006/10/17 $
 */
public class CompilationUnit {
}