Комментарии

Программы читают не только компьютеры, но и люди: другие программисты и вы сами через несколько недель, когда уже не помните, почему написали что-то именно так. Поэтому в языках программирования есть комментарии: заметки в коде, которые компьютер игнорирует.

В Lua комментарий начинается с двух дефисов, --. Lua игнорирует всё, что идёт после них, до конца строки. Комментарий может занимать отдельную строку или стоять в конце строки с кодом:

-- Цена мешка моркови
print(6 * 5) -- одна морковка стоит 5 монет

Программа выведет только:

30

Более длинную заметку помещают между --[[ и ]]. Такой комментарий может занимать несколько строк:

--[[
Ферма Подсолнух
Выводит план Эммы на понедельник.
]]
print("Понедельник: посадить картофель")

Программа выведет:

Понедельник: посадить картофель

Хороший комментарий говорит о том, чего с первого взгляда в коде не видно: для чего нужна часть программы или почему она написана именно так. Комментарий вроде -- выводит Привет над print("Привет") никому не помогает.

Комментарии полезны и для того, чтобы ненадолго отключить код, не удаляя его. Программисты называют это закомментировать: поставьте -- в начале строки, и она больше не выполняется. Когда строка снова понадобится, просто удалите --:

print("Эта строка выполняется.")
-- print("А эта — нет.")

Программа выведет:

Эта строка выполняется.

Чтобы закомментировать сразу несколько строк, поместите их между --[[ и ]]. Только не забудьте ]]. Без него комментарием станет всё до конца программы, и Lua сообщит об ошибке unfinished long comment (starting at line 1) near <eof>: длинный комментарий, который начался на строке 1, так и не закончился, и Lua дошёл до <eof> — конца файла, — а ]] всё ещё искал.