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 Filesystems window or Source Editor and choose Tools and choose Auto Comment.

    The Auto Comment Tool opens in a Source Editor tab. The methods in your source file are listed in the left pane. 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.
  5. Close the tab in the Source Editor when you are finished.

For more information about Javadoc tags, see:

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
Adding a Javadoc Library to a Project

Legal Notices