1. CS 3230 javadoc

2. javadoc tool u Creates HTML files that document Java code uJavadoc comments and tags are used in source files to specify documentation entries uFor more info: java.sun.com/j2se/javadoc/index.jsp

3. What can be documented u Packages u Public classes and interfaces u Public and protected methods u Public and protected fields

4. Documentation Comments u Begins with /** and ends with */ u Contains free form text u Immediately precedes the feature it documents u Can contain HTML tags /** Computes median value */

5. javadoc tags u Follows text and provides additional formatted information uStarts with @ uMust begin the commenting line @author Bill Twilley @version 1.0

6. Generating Comments javadoc –d docDirectory nameOfPackage javadoc –d docDirectory nameOfPackage1 nameOfPackage2… javadoc –d docDirectory *.java