Komentar Luau

Sebuah komentar adalah teks yang diabaikan oleh parser Luau saat runtime.

Komentar satu baris

Anda dapat mendefinisikan komentar satu baris dengan dua tanda hubung (--) di mana saja di luar string. Komentar satu baris memperpanjang hingga ke akhir baris.

Gunakan komentar satu baris untuk catatan dalam garis. Jika komentar meluas ke beberapa baris, gunakan beberapa komentar satu baris.

Anda dapat menambah dan menghapus komentar satu baris di Editor Skrip dengan pintasan keyboard Ctrl/ (⌘/).

-- Kondisi ini sangat penting karena dunia akan meledak jika
-- tidak ada.
if not foo then
	stopWorldFromBlowingUp()
end

Komentar blok

Anda dapat mendefinisikan komentar blok multiline dengan dua tanda hubung dan dua tanda kurung (--[[]]). Gunakan komentar blok untuk mendokumentasikan item:

• Gunakan komentar blok di bagian atas file untuk menjelaskan tujuan mereka.
• Gunakan komentar blok sebelum fungsi atau objek untuk menjelaskan niat mereka.

--[[
    Mematikan sinar bulan kosmik segera.

    Harus hanya dipanggil dalam waktu 15 menit sebelum tengah malam Waktu Standar Mountain,
    atau sinar bulan kosmik mungkin akan rusak.
]]
local function stopCosmicMoonRay()
end

Jika perlu, Anda dapat mengnested beberapa tanda kurung di dalam komentar blok menggunakan jumlah tanda sama-sama di pena dan akhir tanda kurung:

--[=[
    Detail mendalam tentang sinar bulan kosmik: [[[RAHASIA TINGGI]]]
]=]

Arahan komentar

Luau menggunakan komentar yang dimulai dengan ! untuk mengendalikan fitur seperti pemeriksaan tipe, generasi kode asli, dan linting.

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

Untuk linting, Roblox Studio mengaktifkan subset kode peringatan berikut dari linter Luau: 1, 2, 3, 6, 10, 11, 12, 13, 14, 15, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28.

Arahan --!optimize mengendalikan tingkat optimisasi kompiler Luau untuk skrip:

• 0 menonaktifkan optimisasi.
• 1 mengaktifkan optimisasi dasar (default dalam pengujian Studio).
• 2 mengaktifkan optimisasi lebih lanjut (default dalam permainan langsung).

Optimisasi yang tepat tidak dipublikasikan dan dapat berubah. Kami merekomendasikan menggunakan nilai default kecuali Anda memiliki alasan spesifik tidak melakukannya.

Komentar yang perlu dilakukan

Roblox Studio mendukung komentar khusus TODO. Studio mencetak tebal semua teks setelah TODO (hingga terputus oleh spasi):

-- TODO: Selesaikan fungsi di bawah ini sehingga benar-benar melakukan apa yang namanya implikasikan.
local function stopWorldFromBlowingUp()
end

Gunakan komentar TODO untuk melacak dan mengkomunikasikan masalah dalam kode Anda.