Bình luận Luau

Một bình luận là văn bản mà trình phân tích Luau bỏ qua khi thực thi.

Bình luận một dòng

Bạn có thể định nghĩa bình luận một dòng bằng cách sử dụng hai dấu gạch nối (--) ở bất kỳ đâu bên ngoài chuỗi. Bình luận một dòng kéo dài đến cuối dòng.

Sử dụng bình luận một dòng cho các ghi chú bên trong. Nếu bình luận trải dài qua nhiều dòng, hãy sử dụng nhiều bình luận một dòng.

Bạn có thể thêm và xóa bình luận một dòng trong Trình chỉnh sửa Script bằng phím tắt Ctrl/ (⌘/).

-- Điều kiện này thực sự quan trọng vì thế giới sẽ nổ tung nếu nó
-- bị thiếu.
if not foo then
	stopWorldFromBlowingUp()
end

Bình luận khối

Bạn có thể định nghĩa bình luận khối nhiều dòng bằng cách sử dụng hai dấu gạch nối và hai dấu ngoặc vuông (--[[]]). Sử dụng bình luận khối để tài liệu hóa các mục:

• Sử dụng bình luận khối ở đầu các tập tin để mô tả mục đích của chúng.
• Sử dụng bình luận khối trước các hàm hoặc đối tượng để mô tả ý định của chúng.

--[[
    Tắt ngay tia mặt trăng vũ trụ.

    Chỉ nên được gọi trong vòng 15 phút sau nửa đêm Giờ chuẩn Núi,
    nếu không tia mặt trăng vũ trụ có thể bị hỏng.
]]
local function stopCosmicMoonRay()
end

Nếu cần thiết, bạn có thể lồng nhiều dấu ngoặc bên trong bình luận khối sử dụng cùng một số dấu "=" ở cả hai dấu ngoặc đầu và cuối:

--[=[
    Chi tiết sâu về tia mặt trăng vũ trụ: [[[TÍCH CỰC HÀNG ĐẦU]]]
]=]

Chỉ thị bình luận

Luau sử dụng các bình luận bắt đầu bằng ! để điều khiển các tính năng như kiểm tra kiểu, tạo mã gốc, và kiểm tra mã.

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

Đối với kiểm tra mã, Roblox Studio kích hoạt tập con mã cảnh báo sau từ Luau linter: 1, 2, 3, 6, 10, 11, 12, 13, 14, 15, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28.

Chỉ thị --!optimize điều khiển mức độ tối ưu hóa của biên dịch viên Luau cho tập lệnh:

• 0 tắt các tối ưu hóa.
• 1 kích hoạt các tối ưu hóa cơ bản (mặc định trong thử nghiệm Studio).
• 2 kích hoạt các tối ưu hóa thêm (mặc định trong các trò chơi trực tiếp).

Các tối ưu hóa chính xác không được công bố và có thể thay đổi. Chúng tôi khuyên bạn nên sử dụng các giá trị mặc định trừ khi bạn có lý do cụ thể để không làm như vậy.

Bình luận cần làm

Roblox Studio hỗ trợ các bình luận đặc biệt TODO. Studio làm đậm bất kỳ văn bản nào theo sau TODO (cho đến khi bị ngắt bởi một khoảng trắng):

-- TODO: Hoàn thành hàm bên dưới để nó thực sự làm những gì tên của nó ngụ ý.
local function stopWorldFromBlowingUp()
end

Sử dụng các bình luận TODO để theo dõi và truyền đạt các vấn đề trong mã của bạn.