Luau 註解

一個 註解 是 Luau 解析器在執行時會忽略的文字。

單行註解

您可以使用雙破折號 (--) 在字串之外的任何位置定義單行註解。單行註解延伸至行尾。

對於內聯筆記，使用單行註解。如果註解跨越多行，請使用多個單行註解。

您可以在腳本編輯器中使用鍵盤快捷鍵 Ctrl/ (⌘/) 添加和刪除單行註解。

-- 這個條件非常重要，因為如果缺失，世界將會爆炸。
if not foo then
	stopWorldFromBlowingUp()
end

塊註解

您可以使用雙破折號和雙方括號 (--[[]]) 定義多行塊註解。使用塊註解來記錄項目：

• 在文件的頂部使用塊註解來描述它們的目的。
• 在函數或物件之前使用塊註解來描述它們的意圖。

--[[
    立即關閉宇宙月光射線。

    應僅在午夜山區標準時間的 15 分鐘內調用，否則宇宙月光射線可能會受損。
]]
local function stopCosmicMoonRay()
end

如有必要，您可以在塊註解中使用相同數量的等號在開頭和結尾的括號內嵌套多個括號：

--[=[
    有關宇宙月光射線的詳細資訊： [[[最高機密]]]
]=]

註解指令

Luau 使用以 ! 開頭的註解來控制功能，如 類型檢查、原生代碼生成 和 代碼檢查。

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

對於代碼檢查，Roblox Studio 啟用了來自 Luau 代碼檢查器 的以下子集警告代碼：1, 2, 3, 6, 10, 11, 12, 13, 14, 15, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28。

--!optimize 指令控制 Luau 編譯器對腳本的優化級別：

• 0 禁用優化。
• 1 啟用基本優化（Studio 測試中的默認值）。
• 2 啟用進一步的優化（現場遊戲中的默認值）。

具體優化未公開，且可能會變動。我們建議在沒有特定理由的情況下使用默認值。

待辦註解

Roblox Studio 支援特殊的 TODO 註解。Studio 將任何TODO後的文字（直到空格中斷）加粗：

-- TODO: 完成下面的函數，使其實際執行其名稱所暗示的內容。
local function stopWorldFromBlowingUp()
end

使用 TODO 註解來跟踪和溝通您代碼中的問題。