Class 17: Javadoc

Held: Monday, February 20, 2006

Summary: Today we consider javadoc, a special tool for generating documentation for Java.

Related Pages:

• EBoard.
• Reading on Javadoc.
• Lab on Javadoc (not held).

Notes:

• No reading tonight!

Overview:

• Javadoc basics.
• Lab.

Javadoc

• Javadoc is Java's cool tool for generating some documentation for the people who use your classes.
• Every comment that has the form /** ... */ that precedes something (class, method, field, constructor) is a doc comment and can be included in the generated documentation.
• You can also include tags
  • The @author tag gives authors.
  • The @version tag gives the version.
  • The @param name tag describes parameters.
  • The @exception type tag describes exceptions.
  • The @return tag describes return values.
  • The @pre tag describes preconditions.
  • The @post tag describes postconditions.
• We'll do a few samples.

title="Lab">

• Attempt the lab.