Luau-Kommentare

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

Einzeilige Kommentare

Sie können einzeilige Kommentare mit einem doppelten Bindestrich (--) überall außerhalb eines Strings definieren. Einzeilige Kommentare erstrecken sich bis zum Ende der Zeile.

Verwenden Sie einzeilige Kommentare für Inline-Notizen. Wenn der Kommentar mehrere Zeilen umfasst, verwenden Sie mehrere einzeilige Kommentare.

Sie können einzeilige Kommentare im Skripteditor mit der Tastenkombination Strg/ (⌘/) hinzufügen und entfernen.

-- Diese Bedingung ist wirklich wichtig, da die Welt explodieren würde, wenn sie
-- fehlen würde.
if not foo then
	stopWorldFromBlowingUp()
end

Blockkommentare

Sie können mehrzeilige Blockkommentare mit doppelten Bindestrichen und doppelten Klammern (--[[]]) definieren. Verwenden Sie Blockkommentare zur Dokumentation von Elementen:

• Verwenden Sie einen Blockkommentar am Anfang von Dateien, um deren Zweck zu beschreiben.
• Verwenden Sie einen Blockkommentar vor Funktionen oder Objekten, um deren Absicht zu beschreiben.

--[[
    Schaltet den kosmischen Mondstrahl sofort aus.

    Sollte nur innerhalb von 15 Minuten nach Mitternacht Mountain Standard
    Time aufgerufen werden, da der kosmische Mondstrahl sonst beschädigt werden könnte.
]]
local function stopCosmicMoonRay()
end

Falls erforderlich, können Sie mehrere Klammern innerhalb eines Blockkommentars mit der gleichen Anzahl von Gleichheitszeichen sowohl in der Anfangs- als auch in der Endklammer verschachteln:

--[=[
    Detaillierte Informationen über den kosmischen Mondstrahl: [[[TOP SECRET]]]
]=]

Wenn Sie einen Blockkommentar unmittelbar vor einer Deklaration platzieren, zeigt der Skripteditor den Kommentar als Tooltip zur Dokumentation beim Überfahren an. Dies funktioniert auch für Deklarationen innerhalb von Typausdrücken wie typeof(). Siehe Autocomplete-Funktionen für weitere Details.

Kommentar-Direktiven

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

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

Für das Linting aktiviert Roblox Studio die folgende Teilmenge von Warncodes aus dem 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 Optimierungsniveau des Luau-Compilers für das Skript:

• 0 deaktiviert Optimierungen.
• 1 aktiviert grundlegende Optimierungen (Standard in Studio-Tests).
• 2 aktiviert weitere Optimierungen (Standard in Live-Spielen).

Genau 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.

To-do-Kommentare

Roblox Studio unterstützt spezielle TODO-Kommentare. Studio hebt jeden Text nach TODO (bis er durch ein Leerzeichen unterbrochen wird) fett hervor:

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

Verwenden Sie TODO-Kommentare, um Probleme in Ihrem Code zu verfolgen und zu kommunizieren.