Like other programming languages, CCL lets you add comments to document your code.
CCL recognizes two types of comments: doc-comments and regular multi-line comments. Only use doc-comments before CCL top-level statements such as CREATE SCHEMA or CREATE INPUT WINDOW. Doc-comments not immediately preceding a top-level statement are seen as errors by the visual editor with ESP Studio.
Multi-line comments are supported in any context and are therefore recommended over doc-comments.
Begin a multi-line comment with /* and complete it with */. For example:
/* This is a multi-line comment. All text within the begin and end tags is treated as a comment. */
Begin a doc-comment with /** and end it with */. For example:
/** This is a doc-comment. Note that it begins with two * characters instead of one. All text within the begin and end tags is treated as a comment. */ CREATE SCHEMA S1 ...
Note that the doc-comment precedes the CREATE SCHEMA statement (provided here as a sample only and not with complete syntax).
It is common to delineate a section of code using a row of asterisks. For example:
/************************************************************* Do not modify anything beyond this point without authorization **************************************************************/
CCL treats this rendering as a doc-comment because it begins with /**. To achieve the same effect using a multi line comment, insert a space between the first two asterisks: /* *.