Free Trial

Safari Books Online is a digital library providing on-demand subscription access to thousands of learning resources.

  • Create BookmarkCreate Bookmark
  • Create Note or TagCreate Note or Tag
  • PrintPrint
Share this Page URL
Help

Chapter 28. Javadoc

Chapter 28. Javadoc

You already know how to write comments in your classes using the // and /* ... */ notations. These comments serve as documentation that is good mostly for the developer who is writing the class and developers who will continue work on the class. There is another type of documentation in Java. This type is suitable if you are writing API that will be used by other people. You use the javadoc program that comes with the JDK and can be found under the bin directory of your JDK installation. By default, Javadoc generates HTML files that describe packages and types. Every single HTML file generated describes either a package or a type. Within a description of a type you can also describe methods and fields of the type, plus constructors of the type if the type is a class.

Figure 28.1. Java API documentation



  

You are currently reading a PREVIEW of this book.

                                                                                                                    

Get instant access to over $1 million worth of books and videos.

  

Start a Free Trial


  
  • Safari Books Online
  • Create BookmarkCreate Bookmark
  • Create Note or TagCreate Note or Tag
  • PrintPrint