Entering Javadoc Comments in Source Code

See Also

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:

To check your source code for Javadoc comments:

  1. Right-click the file you want to check in the Projects window or Files window and choose Tools > Auto Comment.
  2. 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.
  3. Click Auto Correct.
  4. Make any other desired edits. The Details pane displays "Javadoc comment OK" when the comment is correct.
  5. 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:

See Also
Generating Javadoc Documentation
Adding a Javadoc Library to a Project

Legal Notices