O'Reilly logo

Java™ How to Program, Seventh Edition by P. J. Deitel - Deitel & Associates, Inc., H. M. Deitel - Deitel & Associates, Inc.

Stay ahead with the world's most comprehensive technology and business learning platform.

With Safari, you learn the way you learn best. Get unlimited access to videos, live online training, learning paths, books, tutorials, and more.

Start Free Trial

No credit card required

K.1. Introduction

In this appendix, we provide an introduction to javadoc—a tool used to create HTML files that document Java code. This tool is used by Sun to create the Java API documentation (Fig. K.1). We discuss the special Java comments and tags required by javadoc to create documentation based on your source code and how to execute the javadoc tool. For detailed information on javadoc, visit the javadoc home page at

java.sun.com/javase/6/docs/technotes/guides/javadoc/index.html

Figure K.1. Java source code file containing documentation comments.
 1  // Fig. H.1: Time.java
 2  // Time class declaration with set and get methods.
 3  package com.deitel.jhtp6.appenH; // place Time in a package
 4
 5  /**                                                
 6   * This class maintains the time in 24-hour ...

With Safari, you learn the way you learn best. Get unlimited access to videos, live online training, learning paths, books, interactive tutorials, and more.

Start Free Trial

No credit card required