Commenti Luau

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

Commenti su una sola riga

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

Usa i commenti su una sola riga per note in linea. Se il commento si estende su più righe, usa più commenti su una sola riga.

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

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

Commenti a blocchi

Puoi definire commenti a blocchi multilinea con doppio trattino e doppie parentesi quadre (--[[]]). Usa i commenti a blocchi per documentare gli 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 lunare cosmico.

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

Se necessario, puoi annidare più parentesi all'interno di un commento a blocchi utilizzando lo stesso numero di segni di uguale sia nella parentesi di apertura che in quella di chiusura:

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

Se posizioni un commento a blocchi immediatamente prima di una dichiarazione, l'Editor di Script visualizza il commento come un tooltip di documentazione al passaggio del mouse. Questo funziona anche per dichiarazioni all'interno di espressioni di tipo come typeof(). Vedi le funzionalità di completamento automatico per dettagli.

Direttive di commento

Luau utilizza commenti che iniziano con ! per controllare funzionalità 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 ottimizzazioni di base (predefinito nei test di Studio).
• 2 abilita ulteriori ottimizzazioni (predefinito nei giochi dal vivo).

Le ottimizzazioni esatte non sono pubblicate e sono soggette a modifiche. Si consiglia di utilizzare i valori predefiniti a meno che non si abbia un motivo specifico per non farlo.

Commenti da fare

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

-- TODO: Finire la funzione qui sotto 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 all'interno del tuo codice.