Комментарии в любом языке программирования применяются для пояснения работы переменных, функций, циклов и других фрагментов кода. Это полезно как самому разработчику, чтобы не забыть, как и что он сделал, так и другим разработчикам, чтобы быстро вникнуть в работу программы. Комментарии также помогают упорядочить мысли и тем самым упростить написание программы. В общем, комментировать нужно чаще и больше.
Комментарии в Lua бывают двух типов: однострочные и многострочные. Однострочные комментарии начинаются с двух минусов и всё, что идёт после них компилятор игнорирует.
-- Простой комментарий
-- Немного другой комментарий
-----------------------------------------------
abc = 5; -- переменной abc присвоено значение 5
Допустимо использовать вложенные комментарии, они воспринимаются компилятором как один.
abc = 5; -- переменной abc присвоено значение --5--
Главное не ставить символы -- перед исполняемым кодом. Нужно помнить, что комментарий это всё, что сразу же следует за двумя минусами.
Многострочный комментарий полезно применять, когда надо написать много поясняющего текста или временно исключить из обработки целые фрагменты кода. Пишется подобный комментарий так:
--[[
Это двух-
и более строчный комментарий
--]]
Опять же, внутри одного комментария вполне можно вставлять другой.
--[[
-- Ещё комментарий
--]]