Reading Class Documentation

Key question: For any class, how do we know
Read the Class Documentation!

Class documentation pages are generated by a tool called javadoc from the javadoc comments in a Java source file. These are the comments that start with two asterisks (/** ... */) that come before the class and before each method.

Class Documentation Structure

Every class documentation page has a similar structure.

Example: Simplified Clock Class

Alyce Brady, Kalamazoo College