COMMENTS

There are two types of comments in XCSB, simple and block.

Simple comments start with the comment operator // and entend to the end of the line

Block comments start with the open block comment operator /* and end with the close block comment operator */.

Block comments may be nested. If a block comment exists within another block comment, the open and close block comment operators must be balanced. This is a feature not a fault. It allows sections of code to be quickly as easily made invisible to the compiler by simply marking the section as a block comment regardless of any other block comments that may already be in the section.

simple comment

	// x is mid point between a and b
	x = (a + b) / 2


	// This is the prefered method of adding
	// comments. Multiple line comments simply
	// continue on the next line and the
	// continuation part is prefixed by //

block comment

	/* this is a block comment
	   note how the continuation of the
	   comment on subsequent lines does
	   not need a comment prefix
	*/

commenting out sections of source

before:

	if a > b then

		x = a
	endif

	if a == b then

		x = 0
	endif

	if a < b then

		x = b
	endif

after:

	if a > b then

		x = a
	endif

/*
	if a == b then

		x = 0
	endif
*/

	if a < b then

		x = b
	endif

block comments can be nested

/*
	if a > b then

		x = a
	endif

/*
	if a == b then

		x = 0
	endif
*/

	if a < b then

		x = b
	endif
*/

The simple comment operator // has precedence over the block comment operators /* and */. So the simple comment operator can be used to comment out a block comment operator

e.g.

before:

	if a > b then

		x = a
	endif

/*
	if a == b then

		x = 0
	endif
*/

	if a < b then

		x = b
	endif

after:

/*
	if a > b then

		x = a
	endif

// /* by leaving this here we can see where the start of comment was before we moved it
	if a == b then

		x = 0
	endif
*/

	if a < b then

		x = b
	endif