Commentaires

Un commentaire est texte que le Luau parser ignore au moment de l'exécution.

Commentaires en une ligne

Vous pouvez définir des commentaires à une seule ligne avec un double tiret ( -- ) n'importe où en dehors d'une chaîne. Les commentaires à une seule ligne s'étendent jusqu'au bout de la ligne.

Utilisez des commentaires à une seule ligne pour les notes en ligne. Si le commentaire s'étend sur plusieurs lignes, utilisez plusieurs commentaires à une seule ligne.

Vous pouvez ajouter et supprimer des commentaires à une seule ligne dans le Script Editor avec le raccourci clavier Ctrl/ ( ⌘/).

-- Cette condition est vraiment importante car le monde exploserait si elle
-- ont manqué.
if not foo then
	stopWorldFromBlowingUp()
end

Bloquer les commentaires

Vous pouvez définir des commentaires de blocs multilignes avec des tirets doubles et des guillettes doubles ( --[[]] ). Utilisez les commentaires de blocs pour documenter des articles :

• Utilisez un commentaire de bloc en haut des fichiers pour décrire leur but.
• Utilisez un commentaire de bloc avant les fonctions ou les objets pour décrire leur intention.

--[[
    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 nécessaire, vous pouvez imbriquer plusieurs brackets dans un commentaire de bloc en utilisant le même nombre de signes égaux dans les deux brackets de début et de fin :

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

Commentaires de TODO

Roblox Studio prend en charge les commentaires spéciaux TODO. Studio souligne tout le texte suivant TODO (jusqu'à ce qu'il soit brisé par un espace) :

-- TAD : Terminez la fonction ci-dessous pour que cela soit exactement ce que son nom implique.
local function stopWorldFromBlowingUp()
end

Utilisez les commentaires TODO pour suivre et communiquer les problèmes dans votre code.