Comentarios de Luau

Un comentario es texto que el analizador Luau ignora en tiempo de ejecución .

Comentarios de una sola línea

Puedes definir comentarios de una sola línea con un guión doble ( -- ) en cualquier lugar fuera de una cadena. Los comentarios de una sola línea se extienden hasta el final de la línea.

Usa comentarios de una sola línea para notas en línea. Si el comentario se extiende a varias líneas, usa varios comentarios de una sola línea.

Puedes añadir y eliminar comentarios de una sola línea en el editor de scripts con el atajo de teclado Ctrl/ (⌘/).

-- Esta condición es realmente importante porque el mundo explotaría si
-- faltaban.
if not foo then
	stopWorldFromBlowingUp()
end

Comentarios de bloque

Puedes definir comentarios de bloque multilínea con guiones dobles y paréntesis dobles (--[[]]). Usa comentarios de bloque para documentar elementos:

• Usa un comentario de bloque en la parte superior de los archivos para describir su propósito.
• Usa un comentario de bloque antes de las funciones o objetos para describir su intención.

--[[
    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

Si es necesario, puedes anidar múltiples paréntesis dentro de un comentario de bloque usando el mismo número de signos iguales tanto en el paréntesis de inicio como en el de final:

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

Directivas de comentario

Luau usa comentarios que comienzan con ! para controlar funciones como verificación de tipo , generación de código nativo y limpieza .

--!stricto
--!no estricto
--!nocheck
--!native
--!nointintado
--!optimize 0|1|2

Para la validación, Roblox Studio habilita el siguiente subconjunto de códigos de advertencia del 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 directiva --!optimize controla el nivel de optimización del compilador Luau para el script:

• 0 desactiva las optimizaciones.
• 1 habilita optimizaciones básicas (por defecto en las pruebas de Studio).
• 2 habilita más optimizaciones (por defecto en juegos en vivo).

No se publican optimizaciones exactas y están sujetas a cambios. Recomendamos usar los valores predeterminados a menos que tenga una razón específica para no hacerlo.

Comentarios pendientes

Roblox Studio admite comentarios especiales TODO . Studio negrilla cualquier texto que siga a TODO (hasta que se rompa por un espacio):

-- TODO: Termina la función a continuación para que realmente haga lo que su nombre implica.
local function stopWorldFromBlowingUp()
end

Usa TODO comentarios para realizar un seguimiento y comunicar problemas dentro de tu código.