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 Javadoc Comment dialog box to create your comment.
To add a comment using the Source Editor:
To add a comment using the Auto Comment dialog box:
The Auto Comment Tool dialog box opens and displays the classes, interfaces, and
other entities in the source code and their Javadoc status ( indicates
a valid Javadoc comment,
indicates a
partial or erroneous comment, and
indicates no comment).
Details | Provides information on whether the comment is valid or what's missing from an invalid Javadoc comment. |
Javadoc Comment Text | Provides a text field in which you can modify the comment description.
At the bottom of the dialog box is a row of command buttons you can use to include HTML elements (<B> , <I> , <U> , <CODE> ,
<PRE> ) for formatting your text and the Javadoc tag {@link} .
|
Tags | Provides a list of existing tags in the comment, which you can select and edit. To create a new tag, click New. |
The changes are saved in the source file.
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 |