Auto Comment Tool dialog box
You can open the Auto Comment Tool dialog box by right-clicking on a source file, or one of its elements in the Explorer or Object Browser and choosing Tools | Auto Comment. The Auto Comment Tool dialog box consists of two panes, seven filter icons and four buttons.
Tip: You can use the Auto Comment Tool for multiple files simultaneously. To do so, hold down the SHIFT key while selecting the different files and then right-click and choose Tools | Auto Comment from the contextual menu. However, be sure to not select any item that does not have Tools | Auto Comment on its contextual menu (such as an image or a text file).
![]()
The first pane lists constructors, variables and other elements for comment. Below that, the
Details
pane contains the Declaring Class field, which shows the class that selected element belongs to, and information about missing or invalid comments on the item selected in the first pane.The first three filter icons, respectively, enable you to view class elements
- with completely valid comments
- with partially valid comments (something could be missing or invalid in the Javadoc tags)
- without comment
The next four icons are filters which enable you to view public, package private, protected and private elements of class source.
The dialog box also includes the following buttons:
- Edit Comment... - brings up the Javadoc Comment dialog box, where you can edit the comment. See the following section for more information.
- Auto-Correct... - opens the Javadoc Comment window and automatically corrects any errors in the tags.
- View Source - opens the source file which you are currently documenting and moves the insertion point to the element selected in the Javadoc Comment dialog box.
- Refresh - refreshes the display in the first pane to reflect any changes made in the source file (for example, through the Editor).
Contents | Prev | Next | Index |