Comentarios de Luau

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

Comentarios de una sola línea

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

Utiliza comentarios de una sola línea para notas en línea. Si el comentario abarca varias líneas, utiliza múltiples comentarios de una sola línea.

Puedes agregar 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
-- faltara.
if not foo then
	stopWorldFromBlowingUp()
end

Comentarios en bloque

Puedes definir comentarios en bloque de varias líneas con dobles guiones y dobles corchetes (--[[]]). Utiliza comentarios en bloque para documentar elementos:

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

--[[
    Apaga el rayo cósmico de la luna inmediatamente.

    Solo debe ser llamado dentro de los 15 minutos antes de la medianoche Hora Estándar de la Montaña,
    o el rayo cósmico de la luna puede dañarse.
]]
local function stopCosmicMoonRay()
end

Si es necesario, puedes anidar múltiples corchetes dentro de un comentario en bloque utilizando el mismo número de signos de igual en ambos corchetes de inicio y fin:

--[=[
    Detalle en profundidad sobre el rayo cósmico de la luna: [[[MAYOR SECRETO]]]
]=]

Si colocas un comentario en bloque inmediatamente antes de una declaración, el Editor de Scripts muestra el comentario como un tooltip de documentación al pasar el ratón. Esto también funciona para declaraciones dentro de expresiones de tipo como typeof(). Consulta las Características de autocompletado para más detalles.

Directivas de comentarios

Luau utiliza comentarios que comienzan con ! para controlar características como verificación de tipos, generación de código nativo y linting.

--!estricto
--!noestricto
--!sinverificación
--!nativo
--!sinlint
--!optimizar 0|1|2

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

• 0 desactiva las optimizaciones.
• 1 habilita optimizaciones básicas (valor predeterminado en pruebas de Studio).
• 2 habilita optimizaciones adicionales (valor predeterminado en juegos en vivo).

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

Comentarios de tareas pendientes

Roblox Studio admite comentarios especiales de TODO. Studio resalta en negrita cualquier texto que siga a TODO (hasta que se interrumpa por un espacio):

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

Utiliza comentarios TODO para hacer un seguimiento y comunicar problemas dentro de tu código.