Javadoc Provides More than Documentation
One often overlooked JBuilder Javadoc tag is the @todo tag. In fact, JBuilder has some additional features that give the @todo tag an extra punch. When the @todo tags are placed inside a Javadoc comment, they appear in JBuilder’s Structure pane under a new folder. The To Do folder appears only when one or more @todo tags are present within that source file. Figure 8.2 shows an example of the @todo tag in a JBuilder project.
Figure 8.2. When you click on the @todo tag, it automatically highlights the to-do task.
To add the @todo tag, add this to your code:
1. |
Type todo in the position where you want ... |
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.
