%comment keyword (SDL script)
This keyword outputs a property value as a comment in the code, except when used for generating C.
This output from this keyword is different for each of the code languages:
• For the Ada, each line of the property value is output preceded by two hyphens.
• For the C, the property value is output.
• For the C++, each line of the property value is output preceded by two slash marks.
• For the IDL, each line of the property value is output preceded by two slash marks.
• For the Java, each line of the property value is output preceded by two slash marks, unless the first character of the Description is an asterisk. If the first character of the Description is an asterisk (meaning the Description is a Java document comment), the property value is output preceded by a slash and an asterisk, and suffixed by an asterisk and a slash.
• For the SQL, each line of the property value is output preceded by two slash marks.
 |
You can use the %comment_text keyword to output text as a comment.
|
 |
For C, the %comment keyword generates only the property value, so you must insert additional text to ensure that a comment is generated in the code. For example:
"/*" \n
%comment "Description" \n "*/" \n |
Syntax
%comment "<property name>"
Where <property name> is the automation interface name of the item property. For more information about the automation interface names of properties, see the Automation Interface properties section of the Modeler help.
The following text is included in the SDL script.
%comment "Description"
When processed for a Class whose Description is 'My Description', the following text is generated.
For Ada:
--My Description
For C:
My Description
For C++:
//My Description
For IDL:
//My Description
For Java:
//My Description
For SQL:
My Description