Commentaires Luau

Un commentaire est du texte que le parcourir Luau ignore à l'exécution .

Commentaires en une ligne

Vous pouvez définir des commentaires à une ligne avec un double hyphen ( -- ) n'importe où en dehors d'une chaîne. Les commentaires à une ligne se prolongent jusqu'à la fin de la ligne.

Utilisez des commentaires en une ligne pour les notes en ligne. Si le commentaire couvre plusieurs lignes, utilisez plusieurs commentaires en une ligne.

Vous pouvez ajouter et supprimer des commentaires à une ligne dans l'éditeur de scripts avec le raccourci clavier Ctrl/ ( ⌘/ ).

-- Cette condition est vraiment importante parce que le monde exploserait si elle
-- manquaient.
if not foo then
	stopWorldFromBlowingUp()
end

Bloquer les commentaires

Vous pouvez définir des commentaires de bloc multilignes avec des hyphes doubles et des parenthèses doubles ( --[[]] ). Utilisez les commentaires de bloc pour documenter les éléments :

• 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 parenthèses dans un commentaire de bloc en utilisant le même nombre d'égales signes à la fois dans le parenthèse de début et de fin :

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

Directives de commentaire

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

--!严格ement
--!nonstrict
--!noc检查 sans contrôle
--!natif
--!nolint
--!optimize 0|1|2

Pour l'analyse statique, Roblox Studio active la 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 de Studio).
• 2 permet d'autres optimisations (par défaut dans les jeux en direct).

Les optimisations exactes ne sont pas publiées et sont soumises à changement. 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 spéciaux. Studio souligne tout texte suivant TODO (jusqu'à ce qu'il soit rompu par une espace) :

-- À faire : Terminez la fonction ci-dessous pour qu'elle fasse réellement ce que son nom implique.
local function stopWorldFromBlowingUp()
end

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