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 注释来跟踪和沟通代码中的问题。