Javadoc Comment dialog box


The Javadoc Comment dialog box lets you add comments to class elements separately.

To open the Javadoc Comment dialog box:

The Javadoc Comment dialog box has two main panes. The Javadoc Comment Text pane displays comment text. The Tags pane displays all Javadoc tags used in the comment. When you select a Javadoc tag, a combo box appears along with the Description text field. (If the @see tag is selected, two read-only text areas named Class and Type also appear.)

In the Description pane, you can change the description of the Javadoc tag selected in the combo box. In the combo box you can change the selected Javadoc tag to another Javadoc tag.

There are four buttons on the right side of the Tags pane:

On the bottom of the Javadoc Comment dialog box are buttons with predefined HTML tags and the Javadoc {@link} tag, which you can add to your comment and have displayed in the Javadoc Comment Text pane.

Press OK to accept all changes or Cancel to reject all changes.

Note: For detailed information about Javadoc tags, visit Sun's Javadoc web page, at http://java.sun.com/products/jdk/1.2/docs/tooldocs/solaris/javadoc.html#javadoctags.


Contents Prev Next Index