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:
The Auto Comment Tool is displayed.
The methods in your source file
are listed on the left of the Auto Comment Tool.
The graphic indicates
a valid Javadoc comment,
indicates a
partial or incorrect comment, and
indicates no comment.
If the Javadoc executor cannot generate tags, the Auto Correct button is dimmed.
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
See also | |
---|---|
Generating Javadoc Documentation
Mounting a Javadoc Filesystem |