> For the complete documentation index, see [llms.txt](https://trizen.gitbook.io/sidef-lang/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://trizen.gitbook.io/sidef-lang/syntax_and_semantics/comments.md).

# 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.

```ruby
#
## The hello-world program...
#
say "Hello, world!";         # with single-line comments.
```

## 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.

```c
/*
   This is another style of a comment.
   It allows multiple lines.
*/
```

## Embedded comments

This kind of comments are a little bit weird at the first glance, but they are useful sometimes.

```
var speed = (distance #`(in meters) / time #`(in seconds));
```

is equivalent with:

```ruby
var speed = (distance / time);
```

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.

```
#`(if running under some shell) {
    eval 'exec /usr/bin/sidef $0 ${1+"$@"}'
}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://trizen.gitbook.io/sidef-lang/syntax_and_semantics/comments.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.