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 em linha. Se o comentário abranger 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 multilinha 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 do Horário Padrão das Montanhas,
    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 inicial quanto no final:

--[=[
    Detalhes aprofundados sobre o raio cósmico da lua: [[[MUITO SECRETO]]]
]=]

Se você colocar um comentário em bloco imediatamente antes de uma declaração, o Editor de Scripts exibirá o comentário como uma dica de documentação ao passar o mouse. Isso também funciona para declarações dentro de expressões de tipo, como typeof(). Veja Recursos de Autocompletar para mais detalhes.

Diretrizes de comentários

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

--!strict
--!nonstrict
--!nocheck
--!native
--!nolint
--!optimize 0|1|2

Para linting, o Roblox Studio habilita 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 --!optimize controla o nível de otimização do compilador Luau para o script:

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

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

Comentários de tarefas

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

-- TODO: Terminar 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.