Comments (Scripting)

Comments

What are Comments?

Comments are exactly what they sound like, they're comments. They are there just for organizing code and such. Lua will not do anything with these comments.

Single-line Comments

A comment starts anywhere with a double hyphen (--) and runs until the end of the line:

Example

-- This is an example of a comment

Comments do not appear in the output window. They are mostly to help the programmer understand what a section of code is for in long, complicated scripts.

Block Comments

Lua also offers block comments, which start with the first double brackets and run until the corresponding double brackets:

Example

--[[
This is an example 
of a block comment.    
]]

Leveled Comments

Leveled comments are comments that have different levels of toleration for lower-leveled comments, such as the above block comment.

Example

--[=[
This is a level 1 comment.  
]=]

Below is a level 2 comment, there is no limit to what level a comment is on. But a level 1 comment cannot hold a level 2 or higher, and so forth...

--[==[
This is a level 2 comment.  
]==]

Notice how this comment is on more than one line. In the first example, it is limited to one line.

See Also

Lexical Conventions