Komentarz jest tekstem, który Luau parser ignoruje podczas wykonywania .
Komentarze jednoznaczne
Możesz określić jednoznaczne komentarze za pomocą podwójnego spacji ( -- ) w dowolnym miejscu poza ciągiem. Komentarze jednoznaczne rozciągają się do końca linii.
Użyj komentarzy jednoznacznych dla notatek wiersza. Jeśli komentarz obejmuje wiele linii, użyj wielu komentarzy jednoznacznych.
Możesz dodawać i usuwać jedno linijne komentarze w edytorze skryptów za pomocą skrótu klawiszowego Ctrl/ ( ⌘/ ).
-- To warunek jest naprawdę ważny, ponieważ świat eksplodowałby, gdyby-- brakowało.if not foo thenstopWorldFromBlowingUp()end
Blokuj komentarze
Możesz określić wielokrotne komentarze blokowe za pomocą podwójnych spacji i podwójnych nawiasów (--[[]]). Użyj komentarzy blokowych do dokumentowania przedmiotów:
- Użyj komentarza bloku na górze plików, aby opisać ich cel.
- Użyj komentarza bloku przed funkcjami lub obiektami, aby opisać ich zamiar.
--[[
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
Jeśli to konieczne, możesz zagnąć wiele nawiasów w komentarzu bloku za pomocą tej samej liczby równych znaków zarówno w pierwszym, jak i ostatnim nawiasie:
--[=[In-depth detail about cosmic moon ray: [[[TOP SECRET]]]]=]
Dyrektywy komentarzy
Luau używa komentarzy, które zaczynają się od ! , aby kontrolować funkcje takie jak weryfikacja typu , generacja kodu natywnego i lintowanie .
--!ściśle--!nonstrict--!noczekuj--!native--!niezgłaszaj błędów--!optimize 0|1|2
Do sprawdzania kodów Roblox Studio umożliwia następujący zbiór kodów ostrzeżeń z filtrem Luau: 1, 2, 3, 6, 10, 11, 12, 13, 14, 15, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28.
Dyrektywa --!optimize kontroluje poziom optymalizacji kompilatora Luau dla skryptu:
- 0 wyłącza optymalizacje.
- 1 umożliwia podstawowe optymalizacje (domyślnie w testach w Studio).
- 2 umożliwia dalsze optymalizacje (domyślnie w grach na żywo).
Dokładne optymalizacje nie są publikowane i podlegają zmianie. Polecamy używanie domyślnych wartości, chyba że masz konkretny powód, aby tego nie robić.
Komentarze do zrobienia
Roblox Studio wspiera specjalne komentarze TODO . Studio pogrubia każdy tekst po TODO (do czasu złamania przez spację):
-- ZADANIE: Ukończ funkcję poniżej, aby rzeczywiście zrobiła to, co sugeruje jej nazwa.
local function stopWorldFromBlowingUp()
end
Użyj komentarzy TODO, aby śledzić i komunikować problemy w swoim kodzie.