Siebel eScript Language Reference > Siebel eScript Language Overview > Siebel eScript Concepts >

Comments in Siebel eScript

A comment is text in a script to be read by users and not by the Siebel eScript interpreter, which skips over comments. Comments that explain lines of code help users understand the purpose and program flow of a program, making it easier to alter code.

There are two formats for comments, end-of-line comments and block comments. End-of-line comments begin with two slash characters, "//". Any text after two consecutive slash characters is ignored to the end of the current line. The Siebel eScript interpreter begins interpreting text as code on the next line.

Block comments are enclosed within a beginning block comment, "/*", and an end of block comment, "*/". Any text between these markers is a comment, even if the comment extends over multiple lines. Block comments may not be nested within block comments, but end-of-line comments can exist within block comments.

The following code fragments are examples of valid comments:

// this is an end of line comment

/* this is a block comment.
This is one big comment block.
// this comment is okay inside the 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.";

Siebel eScript Language Reference