Comentários de Luau

Um comentário é texto que o processador 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 ao fim 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 Script com o atalho de teclado Ctrl/ ( ⌘/ ).

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

Bloquear comentários

Você pode definir comentários de bloco multiline com hifens duplos e parênteses duplos ( --[[]] ). Use comentários de bloco para documentar itens:

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

--[[
    Shuts off the cosmic moon ray immediately.

    Should only be called within 15 minutes of midnight Mountain Standard
    Time, or the cosmic moon ray may be damaged.
]]
local function stopCosmicMoonRay()
end

Se necessário, você pode aninhar vários parênteses dentro de um comentário de bloco usando o mesmo número de sinais iguais tanto no parêntese inicial quanto no final:

--[=[
    In-depth detail about cosmic moon ray: [[[TOP SECRET]]]
]=]

Diretivas de comentário

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

--!stringente
--!nonstrict
--!noc检查 não
--!native
--!semintenção
--!optimize 0|1|2

Para validação, o Roblox Studio habilita o seguinte subconjunto de códigos de aviso da Luau linter: 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 no teste do Studio).
• 2 habilita mais otimizações (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 fazer isso.

Comentários a fazer

O Roblox Studio suporta comentários especiais TODO especiais. O Studio negrita qualquer texto após TODO (até quebrado 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 TODO comentários para acompanhar e comunicar problemas dentro do seu código.