Editing Squirrel Comments

A comment is a human readable note which was inserted by a programmer to denote the what, how, or why behind code. Comments are ignored by the compiler and only serve to make the code easier to understand or use for programmers. Comments come in two flavors: single line and multi line comments. Single line comments go until they hit a new line character (\n). Multi line comments have a start and end token, anything between them is commented out.


To insert a single line comment, prefix it with <code>'''//'''</code> or <code>'''#'''</code>.

<syntaxhighlight lang="c#" line="1" start="1" style="font-weight:bold;>
// I'm a comment that takes the whole line
local darth_variable = 404 # I'm an inline comment
</syntaxhighlight>

To insert a multi line comment, use <code>'''/*'''</code> to start and <code>'''*/'''</code> to end.

<syntaxhighlight lang="c" line="1" start="1" style="font-weight:bold;>
/*I
      am
          a
      multi
  line
comment
*/
local foo = 2;
</syntaxhighlight>

You can "nest" single line comments, but you can't do this with multi line comments

<syntaxhighlight lang="c" line="1" start="1" style="font-weight:bold;>
//////////////////////// okay
/* // okay */
/* /* not okay */ */
</syntaxhighlight>

The compiler will end the multi line comment at the first end token (*/) it sees, so the second one is outside of any comments and results in a compile error.