Commenti di Luau

Un commento è testo che il parser Luau ignora in tempo esecuzione .

Commenti a singola riga

Puoi definire commenti a una sola riga con un doppio spazio ( -- ) ovunque al di fuori di una stringa. I commenti a una sola riga si estendono alla fine della linea.

Usa i commenti a singola linea per i commenti in linea. Se il commento si estende su più linee, usa più commenti a singola linea.

Puoi aggiungere e rimuovere commenti a una sola riga nell'Editor di script con il scorciato da tastiera Ctrl/ ( ⌘/ ).

-- Questa condizione è davvero importante perché il mondo esploderebbe se
-- erano mancanti.
if not foo then
	stopWorldFromBlowingUp()
end

Blocca i commenti

Puoi definire commenti blocco multilineari con doppi ipotetici e doppi parentesi ( --[[]] ). Usa i commenti blocco per documentare gli elementi:

• Usa un commento del blocco in cima ai file per descrivere il loro scopo.
• Usa un commento blocco prima delle funzioni o degli oggetti per descrivere il loro intento.

--[[
    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 necessario, puoi annidare più parentesi all'interno di un commento del blocco utilizzando lo stesso numero di segni uguali sia all'inizio che alla parentesi finale:

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

Direttive di commento

Luau utilizza commenti che iniziano con ! per controllare funzionalità come controllo del tipo , generazione del codice nativo e linting .

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

Per la linting, Roblox Studio abilita il seguente sottoinsieme di codici di avviso dal Luau linter : 1, 2, 3, 6, 10, 11, 12, 13, 14, 15, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28.

La direttiva --!optimize controlla il livello di ottimizzazione del compilatore Luau per lo script:

• 0 disabilita le ottimizzazioni.
• 1 consente le ottimizzazioni di base (predefinite durante i test in Studio).
• 2 consente ulteriori ottimizzazioni (default nei giochi dal vivo).

Le ottimizzazioni esatte non vengono pubblicate e sono soggette a cambiamenti. Consigliamo di utilizzare i valori predefiniti a meno che tu non abbia un motivo specifico per non farlo.

Commenti da fare

Roblox Studio supporta commenti speciali TODO . Studio grassetta qualsiasi testo seguente TODO (finché non viene interrotto da uno spazio):

-- TUTTO: Completa la funzione qui sotto in modo che effettivamente faccia ciò che il suo nome implica.
local function stopWorldFromBlowingUp()
end

Usa TODO commenti per tenere traccia e comunicare problemi all'interno del tuo codice.