Comentários Luau

Um comentário é um texto que o parser Luau ignora em tempo de execução.

Comentários de uma linha

Você pode definir comentários de uma linha com um hífen duplo (--) em qualquer lugar fora de uma string. Comentários de uma linha se estendem até o final da linha.

Use comentários de uma linha para notas intercaladas. Se o comentário ocupar várias linhas, use vários comentários de uma linha.

Você pode adicionar e remover comentários de uma linha no Editor de Scripts com o atalho de teclado Ctrl/ (⌘/).

-- Esta condição é realmente importante porque o mundo explodiria se estivesse
-- faltando.
if not foo then
	stopWorldFromBlowingUp()
end

Comentários em bloco

Você pode definir comentários em bloco multilinhas com hífens duplos e colchetes duplos (--[[]]). Use comentários em bloco para documentar itens:

• Use um comentário em bloco no topo dos arquivos para descrever seu propósito.
• Use um comentário em bloco antes de funções ou objetos para descrever sua intenção.

--[[
    Desliga o raio cósmico da lua imediatamente.

    Deve ser chamado apenas dentro de 15 minutos da meia-noite no Horário Padrão da Montanha,
    ou o raio cósmico da lua pode ser danificado.
]]
local function stopCosmicMoonRay()
end

Se necessário, você pode aninhar múltiplos colchetes dentro de um comentário em bloco usando o mesmo número de sinais de igual tanto no colchete de início quanto no de fim:

--[=[
    Detalhe profundo sobre o raio cósmico da lua: [[[SEGREDO ABSOLUTO]]]
]=]

Diretivas de comentário

Luau usa comentários que começam com ! para controlar recursos como verificação de tipo, geração de código nativo e linting.

--!estrito
--!nãoestrito
--!semverificação
--!nativo
--!semlint
--!otimizar 0|1|2

Para linting, o Roblox Studio ativa o seguinte subconjunto de códigos de aviso do linter Luau: 1, 2, 3, 6, 10, 11, 12, 13, 14, 15, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28.

A diretiva --!otimizar controla o nível de otimização do compilador Luau para o script:

• 0 desativa otimizações.
• 1 ativa otimizações básicas (padrão em testes do Studio).
• 2 ativa otimizações adicionais (padrão em jogos ao vivo).

Otimizações exatas não são publicadas e estão sujeitas a alterações. Recomendamos usar os valores padrão, a menos que você tenha um motivo específico para não fazê-lo.

Comentários de afazeres

Roblox Studio suporta comentários especiais TODO. O Studio torna em negrito qualquer texto que siga TODO (até ser interrompido por um espaço):

-- TODO: Termine a função abaixo para que ela realmente faça o que seu nome implica.
local function stopWorldFromBlowingUp()
end

Use comentários TODO para acompanhar e comunicar problemas dentro do seu código.