IBM® Rational® Rhapsody® provides
a mechanism for including Javadoc comments when code is generated
for models developed in Rational Rhapsody for Java.
In general, the Javadoc generation mechanism is
based on the following items:
- Rational Rhapsody properties
called DescriptionTemplate for elements such as classes
and operations. The content of these properties determines the appearance
of the generated Javadoc comments.
- Automatic retrieval of Rational Rhapsody element
fields that correspond to Javadoc tags, such as descriptions and operation
arguments
- Special tags and corresponding keywords that can
be used for standard Javadoc tags that do not have corresponding Rational Rhapsody elements,
for example, @version.