Comments

Single-line comments

The sharp (#) character sequence marks the following text as a single-line comment. Single-line comments end at the end-of-line.
1
#
2
## The hello-world program...
3
#
4
say "Hello, world!"; # with single-line comments.
Copied!

Multiple-line comments

Comments can span multiple lines by using the multiple-line comment style. Such comments start with /* and end with */. The text between those multi-line comment markers is the comment.
1
/*
2
This is another style of a comment.
3
It allows multiple lines.
4
*/
Copied!

Embedded comments

This kind of comments are a little bit weird at the first glance, but they are useful sometimes.
1
var speed = (distance #`(in meters) / time #`(in seconds));
Copied!
is equivalent with:
1
var speed = (distance / time);
Copied!
A common use of embedded comments is to specify a shell evaluation code to execute the actual Sidef script when it's executed by a shell program. However, the eval statement is completely ignored by Sidef since the block in which it is defined, it's never executed.
1
#`(if running under some shell) {
2
eval 'exec /usr/bin/sidef $0 ${1+"[email protected]"}'
3
}
Copied!
Last modified 1yr ago