You can type a Javadoc comment directly in the Source Editor. If you need help with the content or format of the comment, use the Javadoc Comment dialog box to create your comment.
To add a comment using the Source Editor:
/**
, ends with the characters */
and includes a description followed by Javadoc tags.
To add a comment using the Javadoc Comment dialog box:
<B>
, <I>
, <U>
, <CODE>
,
<PRE>
) for formatting your text and the Javadoc tag {@link}
.
a. | Click New. |
b. | In the New Tag dialog box, select a Javadoc tag or type a new tag and click OK. |
c. | In the Description field, type the text of the tag,
including HTML formatting elements (such as <B> and <I> )
and the in-line Javadoc tag {@link} .
|
/**
and ends with the characters */
.
![]() |
To open multiple source files for comment, hold down the Shift key,
select the file names, right-click, and choose
Tools ![]() |
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 | |
---|---|
Javadoc Comments
Generating Documentation With Javadoc Customizing the Output of Javadoc |