Komentarz to tekst, który parser Luau ignoruje w czasie wykonywania.
Komentarze jednoliniowe
Możesz definiować komentarze jednoliniowe za pomocą podwójnego myślnika (--) w dowolnym miejscu poza ciągiem znaków. Komentarze jednoliniowe rozciągają się do końca linii.
Używaj komentarzy jednoliniowych do notatek w linii. Jeśli komentarz zajmuje wiele linii, użyj wielu komentarzy jednoliniowych.
Możesz dodawać i usuwać komentarze jednoliniowe w Edytorze Skryptów za pomocą skrótu klawiaturowego Ctrl/ (⌘/).
-- Ten warunek jest naprawdę ważny, ponieważ świat wybuchłby, gdyby-- go brakowało.if not foo thenstopWorldFromBlowingUp()end
Komentarze blokowe
Możesz definiować wieloliniowe komentarze blokowe za pomocą podwójnych myślników i podwójnych nawiasów (--[[]]). Używaj komentarzy blokowych do dokumentowania elementów:
- Użyj komentarza blokowego na początku plików, aby opisać ich cel.
- Użyj komentarza blokowego przed funkcjami lub obiektami, aby opisać ich zamiar.
--[[
Natychmiast wyłącza kosmiczny promień księżycowy.
Powinno być wywoływane tylko w ciągu 15 minut od północy według
standardowego czasu górskiego, w przeciwnym razie kosmiczny promień
księżycowy może zostać uszkodzony.
]]
local function stopCosmicMoonRay()
end
Jeśli to konieczne, możesz zagnieżdżać wiele nawiasów w komentarzu blokowym, używając tej samej liczby znaków równości zarówno na początku, jak i na końcu nawiasu:
--[=[Szczegółowe informacje na temat kosmicznego promienia księżycowego: [[[TAJNE]]]]=]
Dyrektywy komentarzy
Luau używa komentarzy, które zaczynają się od !, aby kontrolować funkcje takie jak sprawdzenie typu, generowanie kodu natywnego oraz linting.
--!strict--!nonstrict--!nocheck--!native--!nolint--!optimize 0|1|2
W przypadku lintingu Roblox Studio włącza następujący podzbiór kodów ostrzeżeń z lintera 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 włącza podstawowe optymalizacje (domyślnie w testach Studio).
- 2 włącza dalsze optymalizacje (domyślnie w grach na żywo).
Dokładne optymalizacje nie są publikowane i mogą się zmieniać. Zalecamy korzystanie z domyślnych wartości, chyba że masz konkretny powód, aby ich nie używać.
Komentarze do zrobienia
Roblox Studio obsługuje specjalne komentarze TODO. Studio pogrubia każdy tekst po TODO (aż do przerwania przez spację):
-- TODO: Dokończ funkcję poniżej, aby naprawdę robiła to, co sugeruje jej nazwa.
local function stopWorldFromBlowingUp()
end
Używaj komentarzy TODO, aby śledzić i komunikować problemy w swoim kodzie.