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

对于静态分析，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 评论。工作室加粗任何跟随 TODO (直到被空格分开) 的文本：

-- TODO：完成下面的函数，以便它真正地做到它的名称所暗示的内容。
local function stopWorldFromBlowingUp()
end

使用 TODO 评论来跟踪和沟通代码中的问题。