> For the complete documentation index, see [llms.txt](https://docs.werwolv.net/pattern-language/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.werwolv.net/pattern-language/core-language/comments.md).

# Comments

The Pattern Language, just like most other programming languages, supports comments. A comment is a piece of text that is ignored by the evaluator. Comments are useful for documenting your code, and for temporarily disabling code.

### Single line comments

Single line comments start with a double slash (//) and continue to the end of the line.

```cpp
// This is a single line comment
```

### Multi line comments

Multi line comments start with /\* and end with \*/.

```cpp
/* This is
    a multi
    line comment */
```

### Doc comments

Doc comments are used to provide extra documentation for the whole pattern, individual functions or types.

There are multiple ways to write doc comments:

```rust
/*!
    This is a global doc comment.
    It documents the whole pattern and can contain various attributes that can be used by tools to extract information about the pattern.
*/

/**
    This is a local doc comment.
    It documents the function or type that immediately follows it.
*/

/**
    This is a doc comment documenting a function that adds two numbers together
    @param x The first parameter.
    @param y The second parameter.
    @return The sum of the two parameters.
*/
fn add(u32 x, u32 y) {
    return x + y;
};

/// This is a single line local comment. It documents the function or type that immediately follows it.
```


---

# 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://docs.werwolv.net/pattern-language/core-language/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.