Luau yorumları

Bir yorum Luau parlayıcısının çalışma sırasında görmezden geldiği metindir.

Tek satır yorumlar

Bir dize dışında herhangi bir yerde tek satır yorumları iki tire ile tanımlayabilirsiniz ( -- ). Tek satır yorumları satırın sonuna kadar genişletir.

Yer içi notlar için tek satır yorumları kullanın. Yorum birden fazla satıra yayılırsa, çok sayıda tek satır yorum kullanın.

Kısa yol tuşu ile Ctrl/ ( ⌘/ ) kaydettiğiniz tek satır yorumlarını Script Editörü'ne ekleyebilir veya kaldırabilirsiniz.

-- Bu koşul gerçekten önemlidir çünkü dünya patlayacaktır eğer
-- kayıp oldu.
if not foo then
	stopWorldFromBlowingUp()
end

Yorumları engelle

Çok satırlı blok yorumlarını iki tire ve çift parantezle tanımlayabilirsiniz ( --[[]] ). Belgeleme öğeleri için blok yorumlarını kullanın:

• Amaçlarını tanımlamak için dosyaların üstünde bir blok yorumu kullanın.
• Niyetlerini tanımlamak için işlevlerden veya nesnelerden önce bir blok yorumu kullanın.

--[[
    Shuts off the cosmic moon ray immediately.

    Should only be called within 15 minutes of midnight Mountain Standard
    Time, or the cosmic moon ray may be damaged.
]]
local function stopCosmicMoonRay()
end

Gerekirse, başlangıç ve bitiş parantezlerinde aynı sayıda eşit işaret kullanarak bir blok yorumuna çok sayıda parantez yerleştirebilirsiniz:

--[=[
    In-depth detail about cosmic moon ray: [[[TOP SECRET]]]
]=]

Yorum direktifleri

Luau, özellikleri kontrol etmek için ! ile başlayan yorumları kullanır tür kontrolü , yerel kod oluşturma ve düzeltme .

--!sıkıntılı
--!non strict | sıkı olmayan
--!nocheck
--!yerli
--!nolint [istemiyorum]
--!optimize 0|1|2

Lint için, Roblox Studio Luau linter 'dan aşağıdaki uyarı kodu altını etkinleştirir: 1, 2, 3, 6, 10, 11, 12, 13, 14, 15, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28.

The --!optimize direktifi, senaryo 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 optimizasyon sağlar (canlı oyunlarda varsayılan).

Kesin optimizasyonlar yayınlanmaz ve değiştirilmeye tabidir. Belirli bir neden olmadığınız sürece varsayılan değerleri kullanmanızı öneririz.

Yapılacak yorumlar

Roblox Studio özel TODO yorumları destekler. Stüdyo, TODO (boşluk tarafından kırılana kadar) takip eden herhangi bir metni bold eder:

-- YAPILACAKLAR: Aşağıdaki işlevi bitirin, böylece gerçekten adının ima ettiği şeyi yapar.
local function stopWorldFromBlowingUp()
end

Kodunuzdaki sorunları izlemek ve iletmek için TODO yorumlarını kullanın.