Comment template properties

The following table lists the properties (under <lang>_CG) that enable you to standardize the way comments are generated in the code.
Metaclass Property Description
File ImplementationFooter Specifies the multiline footer to be generated at the end of implementation files.
  ImplementationHeader Specifies the multiline header that is generated at the beginning of implementation files.
  SpecificationFooter Specifies the multiline footer to be generated at the end of specification files.
  SpecificationHeader Specifies the multiline header to be generated at the beginning of specification files.
Configuration DescriptionBeginLine Enables you to specify the prefix for the beginning of comment lines in the generated code. This functionality enables you to use a documentation system (such as Doxygen), which looks for a certain prefix to produce the documentation.
Note: This property affects only the code generated for descriptions of model elements; other auto-generated comments are not affected.
  DescriptionEndLine Enables you to specify the prefix for the end of comment lines in the generated code.
Argument

Attribute

Class

Event

Operation

Package

Relation

Type

DescriptionTemplate Specifies how to generate the element description in the code. An empty MultiLine (the default value) tells IBM® Rational® Rhapsody® to use the default description generation rules.

Feedback