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 akan meluas hingga akhir baris.

Gunakan komentar satu baris untuk catatan dalam baris. Jika komentar mencakup 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 tujuannya.
• Gunakan komentar blok sebelum fungsi atau objek untuk menjelaskan niatnya.

--[[
    Mematikan sinar bulan kosmik segera.

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

Jika perlu, Anda dapat menempatkan beberapa tanda kurung di dalam komentar blok menggunakan jumlah tanda sama yang sama di kedua tanda kurung awal dan akhir:

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

Jika Anda menempatkan komentar blok tepat sebelum deklarasi, Editor Skrip akan menampilkan komentar sebagai tooltip dokumentasi saat melayang. Ini juga berfungsi untuk deklarasi di dalam ekspresi tipe seperti typeof(). Lihat Fitur Autocomplete untuk detail lebih lanjut.

Direktif komentar

Luau menggunakan komentar yang dimulai dengan ! untuk mengontrol fitur seperti pemeriksaan tipe, generasi kode native, 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.

Direktif --!optimize mengontrol tingkat optimisasi dari compiler 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 untuk menggunakan nilai default kecuali Anda memiliki alasan spesifik untuk tidak melakukannya.

Komentar to-do

Roblox Studio mendukung komentar khusus TODO. Studio menebalkan teks apa pun yang mengikuti 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.