Javadoc

BankAccount.java

/** * Deposit the given amount onto the account. * * @param amount Amount of money to be deposited in cents. */ public void deposit(int amount) {}

In the next step, the special JavaDoc comments can be added to it.

These comments start with an /** and include tags that begin with the @ character.

The documentation for them may be found in the manual page of javadoc(1) (try the command ``man javadoc'') or at http://java.sun.com/j2se/javadoc/.

Following command sequence generates HTML documents from your sources:
mkdir -p doc              # create doc subdir
javadoc -d doc *.java     # generate HTML documents
netscape doc/index.html&  # look at it

	In the next step, the special JavaDoc comments can be added to it.
	These comments start with an `/**` and include tags that begin with the `@` character.
	The documentation for them may be found in the manual page of javadoc(1) (try the command ``man javadoc'') or at http://java.sun.com/j2se/javadoc/.
	Following command sequence generates HTML documents from your sources: `mkdir -p doc # create doc subdir` `javadoc -d doc *.java # generate HTML documents` `netscape doc/index.html& # look at it`