Değişken Adlandırması: Okunabilir Kod Yazmanın Temel Kuralı

Bir projeyi altı ay sonra açtığında kendi kodunu anlamakta zorlanıyorsan, sorun değişken adlarında olabilir. Bir değişkene verdiğin ad, o değişkeni okuyan herkesin (gelecekteki sen de dahil) ne işe yaradığını anlaması için ilk ipucu.

İyi bir değişken adı ne anlama gelir? Değişkenin amacını tek başına açıklamalı, kısa ama öz olmalı ve yanlış anlamaya yer bırakmamalı. Örneğin a = 5 yerine kullanici_yas = 5 yazarsan, kodun ne yaptığı hemen belli olur.

Adlandırma kurallarını adım adım inceleyelim.

Birinci kural: Değişkenin amacını açıkça belirt. x, temp, data gibi genel adlardan kaçın. Bunlar hiçbir bilgi vermez. Bunun yerine hesaplanan_toplam, gecici_dosya_yolu, kullanici_bilgileri gibi belirgin adlar kullan.

İkinci kural: Yanlış anlamaya yer bırakma. sayac yerine dongu_sayaci yaz. deger yerine ürün_fiyati yaz. Bağlam önemli; aynı isim farklı yerlerde farklı anlama gelebilir.

Üçüncü kural: Türkçe yazıyorsan Türkçe, İngilizce yazıyorsan İngilizce kullan. Karışık adlandırma kodu okuması zorlaştırır. kullanici_count yerine kullanici_sayisi veya user_count seç.

Pratik örneğe bakalım. Bir e-ticaret sisteminde ürün indirimini hesaplayan kod yazıyorsun:

Reklam · TEST
AdSense Test ReklamıYazı arası (gönderi içi) · Yazı arası
1# Kötü örnek
2p = 100
3d = 0.2
4f = p - (p * d)
5print(f)

Bu kodda ne olduğu anlaşılmıyor. Şimdi düzeltilmiş hali:

1urun_fiyati = 100
2indirim_orani = 0.2
3son_fiyat = urun_fiyati - (urun_fiyati * indirim_orani)
4print(son_fiyat)
5# Çıktı: 80.0

İkinci örnekte değişken adlarından hemen anlaşılıyor: 100 lira fiyat, yüzde 20 indirim, sonuç 80 lira. Kod kendi kendini açıklıyor.

Bir kural daha: Sayı veya durum içeren değişkenlerde tür ipucu ver. aktif_mi, musteri_listesi, toplam_siparis gibi. Böylece okuyucu değişkenin ne tür veri tuttuğunu anlar.

Döngülerde kısaltma kabul edilebilir. for i in range(10) veya for j in range(5) gibi. Ama dış döngüde for satir in satirlar yazarsan daha iyi olur.

Son ipucu: Değişken adı 1-2 kelimeyle bitmelidir. kullanici_vergi_numarasi_dogrulama_durumu çok uzun; kdv_dogrulanmis yeterli. Uzun adlar okunabilirliği azaltır, kodu daraltır.

İyi adlandırma alışkanlığı kazandığında, kodu yazması ve okuması daha hızlı olur. Hata ayıklamak kolaylaşır, ekip çalışması düzgün ilerler. Başla şimdi: yazdığın her değişkeni sorguyla adlandır: "Bu değişkenin adını okuyan biri ne anlayacak?"

Reklam · TEST
AdSense Test ReklamıGönderi altı · Görüntülü
konu hakkında tepkinizi verebilirsiniz