Siebel eScript Language Reference > Using Siebel eScript > Guidelines for Using Siebel eScript >

Use Comments to Document Your Code

A comment is text in a script that you can use to document the script. It can describe the intent of the code flow, which simplifies modifications and debugging. Siebel eScript skips comments. Siebel eScript includes the following types of comments:

• End-of-line comment. Begins with two forward slashes (//). It ignores any text that occurs from after these slashes to the end of the current line. It begins interpreting the code that occurs on the next line.
• Statement block comment. Begins with a forward slash and an asterisk (/*). Ends with an asterisk and a forward slash (*/). Text between these markers is a comment even if the comment extends over multiple lines. You cannot write code that includes a statement block comment in a statement block comment. You can include an end-of-line comment in a statement block comment.

The following code includes valid comments:

// this is an end of line comment

/* this is a statement block comment.
This is one big comment block.
// this comment is okay in the statement block.
The interpreter ignores it.
*/

var FavoriteAnimal = "dog"; // except for poodles

//This line is a comment but
var TestStr = "This line is not a comment.";