Un commentaire est un texte que le parseur Luau ignore à l'exécution.
Commentaires sur une seule ligne
Vous pouvez définir des commentaires sur une seule ligne avec un double tiret (--) n'importe où en dehors d'une chaîne. Les commentaires sur une seule ligne s'étendent jusqu'à la fin de la ligne.
Utilisez des commentaires sur une seule ligne pour des notes en ligne. Si le commentaire s'étend sur plusieurs lignes, utilisez plusieurs commentaires sur une seule ligne.
Vous pouvez ajouter et supprimer des commentaires sur une seule ligne dans l'éditeur de script avec le raccourci clavier Ctrl/ (⌘/).
-- Cette condition est vraiment importante car le monde exploserait si elle
-- était manquante.
if not foo then
stopWorldFromBlowingUp()
endCommentaires en bloc
Vous pouvez définir des commentaires en bloc multilignes avec des doubles tirets et des doubles crochets (--[[]]). Utilisez des commentaires en bloc pour documenter des éléments :
- Utilisez un commentaire en bloc en haut des fichiers pour décrire leur objectif.
- Utilisez un commentaire en bloc avant des fonctions ou des objets pour décrire leur intention.
--[[
Éteint le rayon lunaire cosmique immédiatement.
Ne doit être appelé que dans les 15 minutes suivant minuit, heure normale
des Rocheuses, sinon le rayon lunaire cosmique peut être endommagé.
]]
local function stopCosmicMoonRay()
endSi nécessaire, vous pouvez imbriquer plusieurs crochets à l'intérieur d'un commentaire en bloc en utilisant le même nombre de signes égaux dans les crochets de début et de fin :
--[=[
Détails approfondis sur le rayon lunaire cosmique : [[[TOP SECRET]]]
]=]Si vous placez un commentaire en bloc immédiatement avant une déclaration, l'éditeur de script affiche le commentaire comme une info-bulle de documentation au survol. Cela fonctionne également pour les déclarations à l'intérieur d'expressions de type telles que typeof(). Voir Fonctionnalités d'autocomplétion pour plus de détails.
Directives de commentaire
Luau utilise des commentaires qui commencent par ! pour contrôler des fonctionnalités telles que vérification de type, génération de code natif et linting.
--!strict
--!nonstrict
--!nocheck
--!native
--!nolint
--!optimize 0|1|2Pour le linting, Roblox Studio active le sous-ensemble suivant de codes d'avertissement du 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 directive --!optimize contrôle le niveau d'optimisation du compilateur Luau pour le script :
- 0 désactive les optimisations.
- 1 active les optimisations de base (par défaut dans les tests Studio).
- 2 active des optimisations supplémentaires (par défaut dans les jeux en direct).
Les optimisations exactes ne sont pas publiées et sont susceptibles de changer. Nous recommandons d'utiliser les valeurs par défaut à moins que vous n'ayez une raison spécifique de ne pas le faire.
Commentaires à faire
Roblox Studio prend en charge des commentaires spéciaux TODO. Studio met en gras tout texte suivant TODO (jusqu'à ce qu'il soit interrompu par un espace) :
-- TODO: Terminer la fonction ci-dessous afin qu'elle fasse réellement ce que son nom implique.
local function stopWorldFromBlowingUp()
endUtilisez des commentaires TODO pour suivre et communiquer des problèmes dans votre code.