Java denotes comments in three ways:
- Double slashes in front of a single line comment:
int
i=5; // Set the integer to 5
- Matching slash-asterisk (/*)
and asterisk-slash (*/)
to bracket multi-line comments :
/*
Set the integer to 5
*/
int i=5;
- Matching slash-double asterisk (/**)
& asterisk-slash(*/)
for Javadoc automatic
hypertext documentation, as in
/**
This applet tests graphics.
*/
public class testApplet extends applet{...
or
/**
* Asterisks inside the comment
are ignored by javadoc so they
* can be used to make nice line
markers.
**/
The SDK tool javadoc
uses the latter /**
..*/ comment style when it produces hypertext pages to describe
a class. See the Java
2 API Specifications for examples of javadoc
output.
Discuss javadoc
further in Chapter 5: Java:
Javadoc.
References & Web Resources
Latest update: Oct. 14, 2004
|