Commenti Luau

Un commento è un testo che il parser Luau ignora durante l'esecuzione.

Commenti su una singola linea

Puoi definire commenti su una singola linea con un doppio trattino (--) ovunque al di fuori di una stringa. I commenti su una singola linea si estendono fino alla fine della linea.

Usa i commenti su una singola linea per note inline. Se il commento si estende su più righe, utilizza più commenti su singole linee.

Puoi aggiungere e rimuovere commenti su una singola linea nell'Editor di Script con la scorciatoia da tastiera Ctrl/ (⌘/).

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

Commenti a blocchi

Puoi definire commenti a blocchi multi-linea con doppio trattino e doppie parentesi quadre (--[[]]). Usa i commenti a blocchi per documentare elementi:

• Usa un commento a blocchi all'inizio dei file per descriverne lo scopo.
• Usa un commento a blocchi prima di funzioni o oggetti per descriverne l'intento.

--[[
    Spegne immediatamente il raggio cosmico della luna.

    Dovrebbe essere chiamato solo entro 15 minuti dalla mezzanotte del
    Mountain Standard Time, altrimenti il raggio cosmico della luna potrebbe
    essere danneggiato.
]]
local function stopCosmicMoonRay()
end

Se necessario, puoi annidare più parentesi all'interno di un commento a blocchi usando lo stesso numero di segni di uguale sia nell'inizio che nella fine della parentesi:

--[=[
    Dettagli approfonditi sul raggio cosmico della luna: [[[TOP SECRET]]]
]=]

Direttive di commento

Luau utilizza commenti che iniziano con ! per controllare funzioni come verifica dei tipi, generazione di codice nativo e linting.

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

Per il linting, Roblox Studio abilita il seguente sottoinsieme di codici di avviso dal linter Luau: 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 abilita le ottimizzazioni di base (predefinite nei test di Studio).
• 2 abilita ulteriori ottimizzazioni (predefinite nei giochi dal vivo).

Le ottimizzazioni esatte non sono pubblicate e possono essere soggette a modifiche. Ti consigliamo di utilizzare i valori predefiniti a meno che tu non abbia un motivo specifico per non farlo.

Commenti da fare

Roblox Studio supporta i commenti speciali TODO. Studio fissa in grassetto qualsiasi testo che segue TODO (fino a quando non viene interrotto da uno spazio):

-- TODO: Finire la funzione sottostante in modo che faccia effettivamente ciò che il suo nome implica.
local function stopWorldFromBlowingUp()
end

Usa i commenti TODO per tenere traccia e comunicare problemi nel tuo codice.