Borland® JBuilder™ Developer’s Guide

Design Guidelines

Defining design guidelines for documentation is like trying to explain to someone else what art is. The important focus of documentation is to remember that you are communicating the purpose, describing the input/output behavior, and explaining the complexities for a given module. These guidelines are meant to assist you in producing high-quality and descriptive documentation for your modules.

Documentation Usage Focused

It is important to understand the usage of the documentation you are creating so that you can address the appropriate needs of the user. Documentation usage in Java with Javadoc is divided into two main categories. Because of these different usages, you should develop or write the documentation comments in ...