Javadoc Comment dialog box
The Javadoc Comment dialog box lets you add comments to class elements separately.
To open the Javadoc Comment dialog box:
- Press Edit Comment... in the AutoComment Tool dialog box; or
- Open the property sheet for the element you want to document, click on the value of the
Javadoc Comment
property, and then click on the ... button that appears.![]()
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 namedClass
andType
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:
- New - brings up the New Tag dialog box, which enables you to choose from predefined Javadoc tags or type another tag. It is element sensitive, so only appropriate tags on class members are shown.
- Delete - deletes the selected tag in the Tags combo box.
- Move Up and Move Down - change the order of the Javadoc tags in the comment by moving the selected tag up or down.
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 |