%comment_text keyword (SDL script)
This keyword outputs specified text as a comment in the code, except when used for generating C.
This output from this keyword is different for each of the languages:
• For Ada, the specified text is output preceded by two hyphens.
• For C, the specified text is output.
• For C#, the specified text is output.
• For C++, the specified text is output preceded by two slash marks.
• For IDL, the specified text is output preceded by two slash marks.
• For Java, the specified text is output preceded by two slash marks.
• For SQL, the specified text is output preceded by two hyphens.
If the line length is limited through the Line Length statement in the Scheme.ini file, each line is prefixed with the appropriate comment characters. For more information about the Line Length statement, see Code formatting and inclusion of special characters in SDL script (TDK).
 |
For C and C#, the %comment_text keyword generates only the text value, so you must insert additional text to ensure that a comment is generated in the code. For example:
"/*" \n
%comment_text "My Description" \n "*/" \n |
Syntax
%comment_text "<text>"
The following text is included in the SDL script.
%comment_text "My Description"
When processed, the following text is generated.
For Ada:
--My Description
For C:
My Description
For C#:
My Description
For C++:
//My Description
For IDL:
//My Description
For Java:
//My Description
For SQL:
--My Description