Luau yorumları

Bir yorum, Luau derleyicisinin çalışma zamanında görmezden geldiği metindir.

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.

Satır içi 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 Editörü'nde tek satırlı yorumlar eklemek ve kaldırmak için klavye kısayolunu Ctrl/ (⌘/) kullanabilirsiniz.

-- Bu koşul gerçekten çok önemlidir çünkü yoksa dünya patlayacaktır.
if not foo then
	stopWorldFromBlowingUp()
end

Blok yorumları

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

• Dosyaların en üstünde bir blok yorumu kullanarak amaçlarını tanımlayın.
• Fonksiyonlar veya nesnelerden önce bir blok yorumu kullanarak niyetlerini açıklayın.

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

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

Gerekirse, bir blok yorum içinde aynı sayıda eşit işareti kullanarak birden fazla köşeli parantezi iç içe geçirebilirsiniz:

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

Yorum yönergeleri

Luau, ! ile başlayan yorumları, tip kontrolü, yerli 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 yönergesi, 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 neden yoksa varsayılan değerleri kullanmanızı öneririz.

Yapılacak yorumlar

Roblox Studio, özel TODO yorumlarını destekler. Studio, TODO'dan sonraki herhangi bir metni (bir boşluk ile kesilene kadar) kalın yazar:

-- TODO: Aşağıdaki fonksiyonu tamamlayın, böylece gerçekten isminin ima ettiğini yapar.
local function stopWorldFromBlowingUp()
end

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