Luau のコメント

A comment is text that the Luau parser ignores at runtime.

一行コメント

You can define single-line comments with a double hyphen (--) anywhere outside a string. Single-line comments extend to the end of the line.

Use single line comments for in-line notes. If the comment spans multiple lines, use multiple single-line comments.

You can add and remove single-line comments in the Script Editor with the keyboard shortcut Ctrl/ (⌘/).

-- この条件は非常に重要です。なぜなら、これが欠けていると
-- 世界が爆発してしまうからです。
if not foo then
	stopWorldFromBlowingUp()
end

ブロックコメント

You can define multiline block comments with double hyphens and double brackets (--[[]]). Use block comments for documenting items:

• Use a block comment at the top of files to describe their purpose.
• Use a block comment before functions or objects to describe their intent.

--[[
    宇宙の月光線を即座に停止します。

    山岳標準時の真夜中から15分以内にのみ呼び出すべきであり、そうでないと宇宙の月光線が損傷する可能性があります。
]]
local function stopCosmicMoonRay()
end

If necessary, you can nest multiple brackets inside a block comment using the same number of equal signs in both the beginning and ending bracket:

--[=[
    宇宙の月光線に関する詳細: [[[トップシークレット]]]
]=]

コメントディレクティブ

Luau uses comments that start with ! to control features like type checking, native code generation, and linting.

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

For linting, Roblox Studio enables the following subset of warning codes from the Luau linter: 1, 2, 3, 6, 10, 11, 12, 13, 14, 15, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28.

The --!optimize directive controls the optimization level of the Luau compiler for the script:

• 0 disables optimizations.
• 1 enables basic optimizations (default in Studio testing).
• 2 enables further optimizations (default in live games).

Exact optimizations aren't published and are subject to change. We recommend using the default values unless you have a specific reason not to.

To-do コメント

Roblox Studio supports special TODO comments. Studio bolds any text following TODO (until broken by a space):

-- TODO: 以下の関数を完成させて、その名前が示す通りに実行するようにします。
local function stopWorldFromBlowingUp()
end

Use TODO comments to keep track of and communicate issues within your code.