7.16 Generating Web-Style Documentation with Javadoc

In most corporations and organizations, programmers share code and frequently use classes developed by another programmer. If the class is well designed and well documented, it will be easy for others to use that class. After all, that is essentially what we have been doing by using existing Java classes. It has been easy to understand what functions these existing classes perform, what they encapsulate, how the constructors work, what the methods do, and how to use the classes. The reason that these classes are easy to understand and use is not only that they are well designed and written, but also that the available documentation, particularly on Oracle’s Java website, is clear, easy to ...

Get Java Illuminated, 5th Edition now with the O’Reilly learning platform.

O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.