Adding Comments
You can add many different types of Javadoc comments to your application source. The application source can contain documentation at many different levels: class and interface as well as methods, constructors, and attributes. When these special comments are merged with the source code, the Javadoc utility follows a few simple rules to dynamically build the documentation. The identifying mark of a Javadoc comment is /** at the start of the comment and */ at the end. Listing 8.1 is an example of Javadoc commenting tags within a source file, and Figure 8.1 displays the documentation generated.
Figure 8.1. When you click on the Doc tab, JBuilder produces documentation using the Javadoc on-the-fly parser.
Listing 8.1. Java Code ...
Get Borland® JBuilder™ Developer’s Guide 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.
