Java and Database Connectivity: Slide 32

Java and Database Connectivity

A bit about syntax: comments

package uk.co.weft.clock;

import java.lang.*;     // import general utility classes
import java.awt.*;      // for graphics handling

Anything on a line following two slash characters (//) is a comment
Nothing special about this kind of comment

/** A subclass of Hand which is just a blob rotating at a fixed
 *  length about the centre. All the mechanism for moving the 
 *  hand is in Hand.
 *
 *  @author Simon Brooke (simon@jasmine.org.uk)
 *  @version $Revision: 1.9 $
 */

Anything between slash-star (/*) and star-slash (*/) is a comment
If it starts with slash-star-star (/**) it's a javadoc comment
- javadoc is a program which automatically generates documentation for Java classes and packages by associating /** comments with the declaration that immediately follows them
- If there isn't a declaration after a /** comment javadoc will ignore it
- @author and @version are special tokens understood by javadoc
- $Revision ... $ is a special token used understood by the version control system I use

give me feedback on this page // show previous feedback on this page