Checking Code for Javadoc Comments

See Also

You can use the Auto Comment Tool to check your source code for Javadoc comments. The tool determines whether:

To check your source code for Javadoc comments:

  1. In the Explorer, right-click the file for which you want to check comments. Or,if the file is open in the Source Editor, right-click anywhere in the file. Then choose Tools and choose Auto Comment.

    The Auto Comment Tool is displayed. The methods in your source file are listed on the left of the Auto Comment Tool. The OK icon graphic indicates a valid Javadoc comment, Error icon indicates a partial or incorrect comment, and Missing icon indicates no comment.

  2. Select the method for which you want to correct tagging errors or generate missing tags.
  3. Click Auto Correct.
  4. Make any other edits. The Details pane indicates "Javadoc comment OK" when the comment is correct.

For more information about Javadoc tags, visit the Sun Microsystems web page at
http://java.sun.com/j2se/1.4/docs/tooldocs/solaris/javadoc.html. For information on how to write Javadoc comments, see
http://java.sun.com/products/jdk/javadoc/writingdoccomments/index.html.

See Also
Generating Javadoc Documentation
Mounting a Javadoc Filesystem

Legal Notices