Commentaires Luau

*Ce contenu est traduit en utilisant l'IA (Beta) et peut contenir des erreurs. Pour consulter cette page en anglais, clique ici.

Un commentaire est un texte que le parseur Luau ignore à l'exécution.

Roblox Studio a une fonctionnalité de commentaires portant un nom similaire qui n'est pas liée aux commentaires de code dans Luau.

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()
end

Commentaires en bloc

Vous pouvez définir des commentaires en bloc multiligne 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 cosmique de la lune immédiatement.

    Ne doit être appelé que dans les 15 minutes précédant minuit heure normale des montagnes,
    sinon le rayon cosmique de la lune peut être endommagé.
]]
local function stopCosmicMoonRay()
end

Si nécessaire, vous pouvez imbriquer plusieurs crochets à l'intérieur d'un commentaire en bloc en utilisant le même nombre de signes égal pour le crochet de début et celui de fin :


--[=[
    Détails approfondis sur le rayon cosmique de la lune : [[[TOP SECRET]]]
]=]

Directives de commentaire

Luau utilise des commentaires qui commencent par ! pour contrôler des fonctionnalités comme la vérification de type, la génération de code natif, et le linting.


--!strict
--!nonstrict
--!nocheck
--!native
--!nolint
--!optimize 0|1|2

Pour le linting, Roblox Studio active le sous-ensemble suivant des 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 de 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()
end

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

Français