Luau 評論

一個 評論 是 Luau 解析器在運行時忽略的文字。

單行評論

您可以使用雙重橫條在字串外的任何地方定義單行評論（--）。單行評論會延伸到字串末端。

使用單行評論對線上評論進行評論。如果評論橫跨多個行，請使用多個單行評論。

您可以使用快捷鍵 Ctrl/ ( ⌘/ ) 在腳本編輯器中添加和移除單行評論。

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

阻止評論

您可以使用雙倍橫線和雙倍括號來定義多行方塊評論（--[[]]）。使用方塊評論來記錄項目：

• 使用檔案頂部的方塊評論來描述其目的。
• 在函數或對象之前使用區塊評論來描述其意圖。

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

如有需要，您可以使用相同數量的等號標記在開始和結束括號內巢穴多個括號評論：

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

評論指令

Luau使用開始於 ! 的評論來控制功能，例如 類型檢查 , 原生代碼生成 和 編輯 。

--！嚴格
--!非嚴格
--！nocheck
--!原生
--!nolint
--!optimize 0|1|2

對於linting，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 (直到被空格破壞) 的文字：

-- 待辦：完成下面的功能，以便它真正地做出它的名稱所暗示的內容。
local function stopWorldFromBlowingUp()
end

使用 TODO 評論來跟蹤和溝通代碼中的問題。