You can type a Javadoc comment directly in the Source Editor. If you need help with the content or format of a Javadoc comment, use the Auto Comment dialog box to create your comment.
To add a comment using the Auto Comment dialog box:
The Auto Comment Tool dialog box opens and displays the methods in the source code and their Javadoc status.
indicates
a valid Javadoc comment,
indicates a
partial or erroneous comment, and
indicates no comment.
If the Javadoc executor cannot generate tags for the comment, the Auto-Correct button is inactive.
The IDE takes following actions:
For example, if your code includes the method
public String myMethod(Object param1, Object param2){}and you click Auto-Correct, the IDE generates the following tags:
@param param1 @param param2 @return
At the bottom of the dialog box is a row of command buttons you can use to include HTML elements for formatting your text. You can also include the Javadoc tag {@link}.
The Details panel will include "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.3/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 | |
---|---|
Format of a Javadoc Comment
Generating Javadoc Documentation |