Kural
Kullanım açıklayıcı değişken kullan.
Çok kısa değişken adları yazılması kodun anlaşılmaz hale getirir.
Desteklenen diller: 45+Giriş
Tek harfli veya anlaşılması zor değişken adları, okuyucuların kodu bir bakışta anlamak yerine anlamını bağlamdan çıkarmaya zorlar. Adı d tarih, süre, mesafe veya veriyi ifade edebilir ve fonksiyon boyunca amacını takip etmek için zihinsel çaba gerektirebilir. Şu gibi açıklayıcı isimler: kullanıcı Tarafından Oluşturulma Tarihi veya istek Süresi bilişsel yük yaratmadan niyeti anında netleştirmek.
Neden önemli?
Kod bakım kolaylığı: Belirsiz değişken adları, kodun anlaşılmasını yavaşlatır. Geliştiriciler, asıl mantığa odaklanmak yerine x, tmp veya val gibi değişkenlerin neyi temsil ettiğini anlamaya zaman harcarlar. Kötü isimlendirme, yeni mantığın nereye yerleştirileceği veya mevcut değerlerin birbirleriyle nasıl ilişkili olduğu belirsiz olduğu için kodun genişletilmesini de zorlaştırır. Üstelik, belirsiz isimler kod tabanını aranamaz hale getirir; çünkü tmp veya val araması anlamlı sonuçlar vermez. Bu durum, aylar sonra koda geri dönüldüğünde veya yeni ekip üyeleri katıldığında daha da karmaşık hale gelir.
Hata açıklaması: Belirsiz isimler, yanlış değişkeni kullanma olasılığını artırır. Birden fazla değişkenin benzer ve anlaşılması zor isimleri olduğunda (d1, d2, d3), geliştiriciler yanlış olanı kullanabilir ve isimler anlamsal ipucu sağlamadığından kod incelemesinden geçen ince hatalara yol açabilir.
Kod örnekleri
❌ Uygun değil:
function calcAmt(u, qty) {
const p = u.prc;
const d = u.disc || 0;
const t = p * qty;
const a = t - (t * d);
const tx = a * 0.08;
return a + tx;
}
Neden yanlış: Şu tür değişken adları: u, p, d, t, ve bunların amacına dair hiçbir ipucu vermez. Okuyucular, şunu anlamak için hesaplama mantığını adım adım takip etmelidir: p fiyat, d indirimdir, t ara toplamdır ve a Bu, vergi öncesi tutardır.
✅ Uygunluk:
function calculateOrderAmount(product, quantity) {
const price = product.price;
const discount = product.discount || 0;
const subtotal = price * quantity;
const amountAfterDiscount = subtotal - (subtotal * discount);
const tax = amountAfterDiscount * 0.08;
return amountAfterDiscount + tax;
}
Bunun önemi: Her değişken adı, içerdiği şeyi açıklar. indirim sonrası tutar hesaplama durumunu açıkça gösterir, vergi kesin bir anlam taşır ve ürün ve miktar fonksiyonun gövdesini okumaya gerek kalmadan girdi değerlerini ortaya çıkarmak.
Sonuç
Bağlam gerektirmeden amacını ortaya koyan isimler kullanın. Kısa olmaktan ziyade açıklığa öncelik verin. İçindeki fazladan karakterler toplamFiyat karşı tp Uygulamada hiçbir maliyeti yoktur, ancak anlamada önemli ölçüde zaman tasarrufu sağlar.
