Komentar Luau

Komentar adalah teks yang diabaikan oleh pemroses Luau saat menjalankan .

Komentar satu baris

Anda dapat mendefinisikan komentar satu baris dengan hipen ganda ( -- ) di luar string. Komentar satu baris diperpanjang ke akhir baris.

Gunakan komentar satu baris untuk catatan dalam baris. Jika komentar meluas lebih dari satu baris, gunakan beberapa komentar satu baris.

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

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

Blok komentar

Anda dapat mendefinisikan komentar blok multiline dengan huruf ganda dan tanda kurung ganda ( --[[]] ). Gunakan komentar blok untuk dokumentasi item:

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

--[[
    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

Jika diperlukan, Anda dapat menyematkan beberapa kurungan dalam komentar blok menggunakan jumlah tanda sama di awal dan akhir kurungan yang sama:

--[=[
    In-depth detail about cosmic moon ray: [[[TOP SECRET]]]
]=]

Direktif komentar

Luau menggunakan komentar yang dimulai dengan ! untuk mengontrol fitur seperti pemeriksaan jenis , pembuatan kode asli , dan pengujian .

--!ketat
--!nonstrict
--!nocheck
--!native
--!tidak ada inti
--!optimize 0|1|2

Untuk linting, Roblox Studio mengaktifkan subset berikut dari kode peringatan dari Luau linter: 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 kompiler Luau untuk skrip:

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

Optimisasi tepat tidak dipublikasikan dan berada di bawah perubahan. Kami sarankan menggunakan nilai default kecuali Anda memiliki alasan khusus untuk tidak melakukannya.

Komentar yang harus dilakukan

Roblox Studio mendukung komentar khusus TODO . Studio miringkan teks apa pun setelah TODO (hingga rusak 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 berkomunikasi masalah dalam kode Anda.