You can use the Auto Comment Tool to automatically enter Javadoc comments
for any code elements that are not documented. The Auto Comment Tool determines
whether:
All Java elements that should be documented have Javadoc comments.
Existing comments correspond with the elements to which they belong. For
example, each parameter in a method must have an @param tag, each
exception thrown from the method must have an @throws tag, and so
on.
To check your source code for Javadoc comments:
Right-click the file you want to check in the Projects window or Files window
and choose Tools > Auto
Comment.
Select the method for which you want to correct tagging errors or generate
missing tags from the list in the left pane. You can use the Filter Toolbar
buttons to
control which classes and members are displayed.
The icon
indicates a valid Javadoc comment, indicates
a partial or incorrect comment, and indicates
no comment.
Click Auto Correct.
If a comment is needed, the IDE generates the missing tags and displays
them in the Tags panel of the Auto Comment dialog box and in the line
immediately preceding the method in the source file.
If a comment is partial or incorrect, the IDE displays information
on how to complete the comment in the Details panel of the Auto Comment
dialog box.
Make any other desired edits. The Details pane displays "Javadoc comment
OK" when
the comment is correct.
When you are finished, quit the Auto Comment Tool by closing its tab
in the Editor window.
For more information about Javadoc tags, see:
For information on how to write Javadoc comments, see: