Appendix 5 Javadoc
The Java language comes with a program named javadoc that will automatically generate HTML documents that describe your classes. This documentation tells somebody who uses your program or class what she or he needs to know in order to use it but omits all the implementation details, such as the bodies of all method definitions (both public and private), all information about private methods, and all private instance variables.
Javadoc is normally used on packages, although it can also be used on single classes. Packages are discussed in Chapter 6. You need to have access to an HTML browser (a Web browser) so that you can view the documents produced by javadoc. However, you do not need to know very much HTML in order to use ...
Become an O’Reilly member and get unlimited access to this title plus top books and audiobooks from O’Reilly and nearly 200 top publishers, thousands of courses curated by job role, 150+ live events each month,
and much more.
Read now
Unlock full access