Checking Javadoc Comments for Accuracy

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

To check the accuracy of the comments in your source code:

  1. Right-click in the Source Editor and 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.

    If the Javadoc executor cannot generate tags, the Auto Correct button is dimmed.

  3. Click Auto Correct.

    The tags are added to the Tags pane of the Auto Comment Tool and in the source file directly above the method. Suppose your code includes this method:

    public String myMethod(Object param1, Object param2){}
    

    The IDE generates the following tags:

    @param param1
    @param param2
    @return
    
  4. Make any other edits. The Details pane indicates "Javadoc comment OK" when the comment is correct.
See also
Generating Javadoc Documentation
Mounting a Javadoc Filesystem

Legal Notices