Luau yorumları

Bir yorum, Luau ayrıştırıcısının çalışma zamanında göz ardı ettiği metinlerdir.

Tek satırlı yorumlar

Tek satırlı yorumları, bir dize dışında herhangi bir yerde çift tire (--) ile tanımlayabilirsiniz. Tek satırlı yorumlar, satırın sonuna kadar uzanır.

İç içe notlar için tek satırlı yorumları kullanın. Eğer yorum birden fazla satıra yayılıyorsa, birden fazla tek satırlı yorum kullanın.

Script Editor'da tek satırlı yorumları ekleyip kaldırmak için klavye kısayolunu kullanabilirsiniz Ctrl/ (⌘/).

-- Bu koşul gerçekten önemlidir çünkü dünya patlayabilir eğer
-- eksikse.
if not foo then
	stopWorldFromBlowingUp()
end

Blok yorumları

Çift tire ve çift köşeli parantez (--[[]]) ile çok satırlı blok yorumları tanımlayabilirsiniz. Blok yorumları, öğeleri belgelemek için kullanılır:

• Dosyaların başında amaçlarını tanımlamak için bir blok yorumu kullanın.
• Fonksiyonlar veya nesnelerden önce niyetlerini tanımlamak için bir blok yorumu kullanın.

--[[
    Kozmik ay ışınını hemen kapatır.

    Sadece gece yarısından 15 dakika içinde çağrılmalıdır,
    aksi takdirde kozmik ay ışını zarar görebilir.
]]
local function stopCosmicMoonRay()
end

Gerekirse, bir blok yorum içinde birden fazla köşeli parantezi, başlangıç ve bitiş parantezinde aynı sayıda eşit işareti kullanarak iç içe yerleştirebilirsiniz:

--[=[
    Kozmik ay ışını hakkında derinlemesine detay: [[[ÜST DÜZEY GİZLİ]]]
]=]

Bir tanımın hemen öncesine bir blok yorumu yerleştirirseniz, Script Editor yorumu üzerine geldiğinizde bir belge aracı ipucu olarak gösterir. Bu, typeof() gibi tür ifadeleri içindeki tanımlar için de çalışır. Ayrıntılar için Tamamlayıcı özellikler bölümüne bakın.

Yorum direktifleri

Luau, ! ile başlayan yorumları, tip kontrolü, yerel kod üretimi ve linting gibi özellikleri kontrol etmek için kullanır.

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

Linting için, Roblox Studio, Luau linter tarafından sağlanan aşağıdaki uyarı kodları alt kümesini etkinleştirir: 1, 2, 3, 6, 10, 11, 12, 13, 14, 15, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28.

--!optimize direktifi, script için Luau derleyicisinin optimizasyon seviyesini kontrol eder:

• 0 optimizasyonları devre dışı bırakır.
• 1 temel optimizasyonları etkinleştirir (Studio testinde varsayılan).
• 2 daha fazla optimizasyonu etkinleştirir (canlı oyunlarda varsayılan).

Kesin optimizasyonlar yayımlanmaz ve değişime tabidir. Belirli bir nedeniniz yoksa varsayılan değerleri kullanmanızı öneririz.

Yapılacak yorumlar

Roblox Studio, özel TODO yorumlarını destekler. Studio, TODOdan sonraki metni (bir boşlukla kesilene kadar) kalın yapar:

-- TODO: Aşağıdaki fonksiyonu tamamlayın, böylece adıyla ifade ettiği şeyi gerçekten yapar.
local function stopWorldFromBlowingUp()
end

TODO yorumlarını, kodunuz içindeki sorunları takip etmek ve iletmek için kullanın.