Luau-Kommentare

Ein Kommentar ist Text, den der Luau-Parser zur Laufzeit ignoriert.

Einzeilige Kommentare

Du kannst einzelne Zeilkommentare mit einem Doppelhyphen ( -- ) überall außerhalb einer Zeile definieren. Einzelzeilige Kommentare werden bis zum Ende der Zeile erweitert.

Verwende Einzeilkommentare für Inline-Notizen. Wenn der Kommentar mehrere Zeilen umfasst, verwende mehrere Einzeilkommentare.

Du kannst einzelne Kommentare im Skript-Editor mit der Tastenkürzel Ctrl/ ( ⌘/ ) hinzufügen und entfernen.

-- Diese Bedingung ist sehr wichtig, weil die Welt explodieren würde, wenn sie
-- fehlten.
if not foo then
	stopWorldFromBlowingUp()
end

Kommentare blockieren

Du kannst mehrzeilige Blockkommentare mit doppelten Unterstrichen und doppelten Klammern definieren ( --[[]] ). Verwende Blockkommentare zur Dokumentation von Gegenständen:

• Verwende einen Blockkommentar am oberen Rand der Dateien, um ihren Zweck zu beschreiben.
• Verwende einen Blockkommentar vor Funktionen oder Objekten, um ihre Absicht zu beschreiben.

--[[
    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

Wenn nötig, können Sie mehrere Klammern in einen Blockkommentar einbetteln, indem Sie die gleiche Anzahl von gleichzeichen sowohl in der Anfangs- als auch in der Endklammer verwenden:

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

Kommentarrichtlinien

Luau verwendet Kommentare, die mit !, um Funktionen wie Typüberprüfung, native Codegeneration und Linting zu steuern.

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

Für Linting aktiviert Roblox Studio den folgenden Unter集 von Warncodes aus der Luau-Linter : 1, 2, 3, 6, 10, 11, 12, 13, 14, 15, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28.

Die --!optimize-Direktive steuert das Optimierungslevel des Luau-Compilers für das Skript:

• 0 deaktiviert optimierungen.
• 1 aktiviert grundlegende Optimierungen (Standard im Studio-Test).
• 2 ermöglicht weitere optimierungen (standard in live-spielen).

Genaue Optimierungen werden nicht veröffentlicht und können sich ändern. Wir empfehlen, die Standardwerte zu verwenden, es sei denn, Sie haben einen bestimmten Grund, dies nicht zu tun.

Zu-Tun-Kommentare

Roblox Studio unterstützt spezielle TODO Kommentare. Studio fettet jeden Text, der nach TODO folgt (bis durch einen Leerzeichen gebrochen):

-- TODO: Beende die Funktion unten, damit sie tatsächlich das tut, was ihr Name impliziert.
local function stopWorldFromBlowingUp()
end

Verwende TODO Kommentare, um Probleme innerhalb deines Codes zu verfolgen und zu kommunizieren.