Comments
Published Aug 4, 2023Updated Jan 19, 2025
Contribute to Docs
A comment is text within a program that is not being executed. It can provide additional information to help understand the code.
Single-line Comments
In Lua, two consecutive dashes are used to create single-line comments. The compiler reads no text after --
on the same line.
function sum(number1, number2)-- this is a commentsum = number1 + number2return sumend
The comment does not affect the function.
Multi-line Comments
In Lua, multi-line comments are created using the --[[
syntax to start the comment and ]]
to end the comment. The compiler does not read any text in between.
--[[ this is a multi-line comment.The compilerwill not run codewritten in between.]]
Contribute to Docs
- Learn more about how to get involved.
- Edit this page on GitHub to fix an error or make an improvement.
- Submit feedback to let us know how we can improve Docs.
Learn Lua on Codecademy
- Career path
Computer Science
Looking for an introduction to the theory behind programming? Master Python while learning data structures, algorithms, and more!Includes 6 CoursesWith Professional CertificationBeginner Friendly75 hours - Free course
Learn Lua
Learn the basics of Lua, a general-purpose programming language used for building games, web apps, and developer tools.Beginner Friendly4 hours