<< Click to Display Table of Contents >> Navigation:  Problem Descriptor Reference > The Elements of a Descriptor > Comments

Problem descriptors can be annotated by adding comments.  

 

Multi-line comments can be placed anywhere in the file.  Multi-line comments are formed by enclosing the desired comments in either curly brackets { and } or the paired symbols /* and */.  Comments can be nested, but comments that begin with a curly bracket must end with a curly bracket and comments that begin with '/*' must end with '*/'.  

 

Example:  

{ this is a comment

so is this.

}

 

End-of-line comments are introduced by  the exclamation mark !. End-of-line comments extend from the ! to the end of the line on which they occur.  Placing the line comment symbol ! at the beginning of a line effectively removes the whole line from the active portion of the problem descriptor, in a manner similar to 'rem' at the beginning of a line in a DOS batch file or "//" in C++.  

 

 

Example:  

! this is a comment

this is not

 

Comments can be used liberally during script development to temporarily remove lines from a problem descriptor. This aids in localizing errors or focusing on specific aspects of a problem.