Neler yeni

Yazılım Forum

Tüm özelliklerimize erişmek için şimdi bize katılın. Kayıt olduktan ve giriş yaptıktan sonra konu oluşturabilecek, mevcut konulara yanıt gönderebilecek, itibar kazanabilecek, özel mesajlaşmaya erişebilecek ve çok daha fazlasını yapabileceksiniz! Bu hizmetlerimiz ise tamamen ücretsiz ve kurallara uyulduğu sürece sınırsızdır, o zaman ne bekliyorsunuz? Hadi, sizde aramıza katılın!

Etkili ve Temiz Fonksiyon Yazımı İçin Kapsamlı İpuçları Kılavuzu

Giriş: Fonksiyonlar ve Temiz Kod Felsefesi

Yazılım geliştirme sürecinin kalbinde fonksiyonlar yer alır. Uygulamanızın her bir parçasının işlevselliğini tanımlayan bu küçük kod blokları, projenizin başarısını doğrudan etkiler. İyi yazılmış fonksiyonlar, sadece mevcut problemleri çözmekle kalmaz, aynı zamanda kod tabanınızın okunabilirliğini, bakımını, test edilebilirliğini ve yeniden kullanılabilirliğini artırır. Ancak, kötü tasarlanmış veya aceleyle yazılmış fonksiyonlar, zamanla biriken teknik borcun ana kaynaklarından biri haline gelebilir ve projenizin sürdürülebilirliğini tehlikeye atabilir. Bu detaylı kılavuzda, yazılım mühendisliğinin en temel taşlarından biri olan fonksiyon yazımı konusunda en iyi uygulamaları, prensipleri ve pratik ipuçlarını derinlemesine inceleyeceğiz. Amacımız, daha sağlam, anlaşılır ve bakımı kolay fonksiyonlar yazmanız için size kapsamlı bir yol haritası sunmaktır. Unutmayın, temiz kod yazmak sadece sizin için değil, ekibinizdeki diğer geliştiriciler için de, hatta gelecekteki 'siz' için de kritik bir yatırım anlamına gelir.

Temiz ve Sürdürülebilir Fonksiyonlar Yazmak İçin Temel İpuçları:

  • 1. Tek Sorumluluk Prensibi (SRP): Fonksiyonlarınızın Tek Bir İşi Olsun
  • 2. Anlamlı ve Açıklayıcı İsimlendirme: Kodunuzu Konuşturun
  • 3. Yan Etkilerden Kaçınma: Beklenmedik Sürprizlere Son Verin
  • 4. Kısa ve Odaklı Fonksiyonlar: Özü Yakalayın
  • 5. Parametre Sayısını Minimize Etme: Aşırı Yüklenmeyi Önleyin
  • 6. Sağlam Hata Yönetimi: Hataları Zarifçe Ele Alın
  • 7. Kapsamlı Dokümantasyon ve Yorumlar: Geleceği Aydınlatın
  • 8. Test Edilebilir Fonksiyonlar Yazmak: Güvenilirliği Garanti Edin

1. Tek Sorumluluk Prensibi (SRP): Fonksiyonlarınızın Tek Bir İşi Olsun

SRP, SOLID prensiplerinin ilk harfini oluşturur ve yazılım tasarımının temelini temsil eder. Bu prensibe göre, her bir fonksiyonun yalnızca bir ve tek bir sorumluluğu olmalı ve bu sorumluluğu mümkün olan en iyi şekilde yerine getirmelidir. Bir fonksiyonun birden fazla nedeni varsa veya birden fazla işlemi aynı anda yapıyorsa, bu, SRP'yi ihlal ettiği anlamına gelir. Örneğin, bir kullanıcıdan veri alan, bu veriyi doğrulayan ve ardından veritabanına kaydeden tek bir fonksiyon, üç farklı sorumluluğu bir araya getirmiş olur. Bu tür bir fonksiyon, veri doğrulama kuralları değiştiğinde, veritabanı şeması güncellendiğinde veya veri alma yöntemi farklılaştığında değişmek zorunda kalır. Bu durum, fonksiyonun karmaşıklığını artırır ve bakımını zorlaştırır. Bunun yerine, her bir işlemi ayrı bir fonksiyona bölmek daha uygun olacaktır:

Kod:
// Kötü Örnek: Birden Fazla Sorumluluğa Sahip Fonksiyon
function kullaniciKaydetVeDogrula(kullaniciVerisi) {
    // 1. Kullanıcı verisini doğrula
    if (!dogrula(kullaniciVerisi)) {
        throw new Error("Geçersiz kullanıcı verisi");
    }
    // 2. Veriyi veritabanına kaydet
    veritabani.kaydet(kullaniciVerisi);
    // 3. Kullanıcıya bildirim gönder
    bildirimServisi.gonder(kullaniciVerisi.email, "Hoş geldiniz!");
}

// İyi Örnek: Tek Sorumluluk Prensibine Uygun Fonksiyonlar
function kullaniciVerisiniDogrula(kullaniciVerisi) {
    // Sadece doğrulama mantığı
    return dogrulamaServisi.dogrula(kullaniciVerisi);
}

function kullaniciyiVeritabaninaKaydet(kullaniciVerisi) {
    // Sadece kaydetme mantığı
    veritabaniServisi.kaydet(kullaniciVerisi);
}

function kullaniciyaHosgeldinEmailiGonder(email) {
    // Sadece email gönderme mantığı
    emailServisi.gonder(email, "Hoş geldiniz!");
}

SRP'ye uymak, kodunuzu daha modüler, yeniden kullanılabilir ve test edilebilir hale getirir. Her fonksiyonun ne yaptığını anlamak çok daha kolaylaşır.

2. Anlamlı ve Açıklayıcı İsimlendirme: Kodunuzu Konuşturun

Fonksiyonların, değişkenlerin ve parametrelerin isimlendirilmesi, kodunuzun okunabilirliğini doğrudan etkileyen en kritik faktörlerden biridir. Kötü isimlendirme, kodunuzu şifre gibi yapar ve diğer geliştiricilerin (veya gelecekteki sizin) ne anlama geldiğini çözmek için gereksiz zaman harcamasına neden olur. Fonksiyon isimleri, ne iş yaptığını açıkça belirtmeli, eylem odaklı olmalı (örneğin, 'get', 'calculate', 'save', 'render') ve mümkün olduğunca spesifik olmalıdır. Parametre isimleri ise, beklenen argümanın amacını ve türünü netleştirmelidir. Tek harfli isimlerden (i, j, k gibi döngü sayaçları hariç), anlamsız kısaltmalardan ve belirsiz terimlerden kaçının.

Kod:
// Kötü Örnek: Anlamsız İsimlendirme
function prcs(d) {
    // Veriyi işler
    return d * 2;
}

// İyi Örnek: Anlamlı ve Açıklayıcı İsimlendirme
function urunFiyatiniHesapla(adet, birimFiyat) {
    // Ürünlerin toplam fiyatını hesaplar
    return adet * birimFiyat;
}

function musteriVerileriniGetir(musteriId) {
    // Belirli bir müşteri ID'sine göre müşteri bilgilerini getirir
    return veritabani.query("SELECT * FROM musteriler WHERE id = ?", musteriId);
}

İyi isimlendirme, yorumlara olan ihtiyacı azaltır ve kodunuzu kendi kendini belgeleyen bir yapıya kavuşturur. Adeta kodunuzu bir hikaye anlatıyormuş gibi düşünebilirsiniz.

3. Yan Etkilerden Kaçınma: Beklenmedik Sürprizlere Son Verin

Bir fonksiyonun yan etkisi, kendi lokal kapsamı dışında bir durumu (örneğin, global bir değişkeni, bir nesnenin özelliğini veya bir veritabanı kaydını) değiştirmesi anlamına gelir. Yan etkileri olan fonksiyonlar, davranışları tahmin edilemez hale getirebilir ve hataların tespiti ile giderilmesini son derece zorlaştırabilir. Mümkün olduğunca, fonksiyonlarınızı 'saf' yapmaya çalışın: yani, sadece girdilerine bağlı olarak çıktı üretmeli ve programın genel durumunu değiştirmemelidir. Saf fonksiyonlar, aynı girdilerle her zaman aynı çıktıyı verir ve dış dünyaya etki etmezler.

Kod:
// Kötü Örnek: Yan Etki (Global Değişkeni Değiştiriyor)
let toplamMiktar = 0;

function urunEkle(fiyat) {
    toplamMiktar += fiyat; // Global değişkeni değiştiriyor
    return toplamMiktar;
}

// İyi Örnek: Yan Etkisiz (Saf Fonksiyon)
function toplamHesapla(mevcutToplam, eklenecekMiktar) {
    return mevcutToplam + eklenecekMiktar; // Sadece çıktı döndürüyor
}

// Kullanım:
let sepetToplam = 0;
sepetToplam = toplamHesapla(sepetToplam, 100); // 100
sepetToplam = toplamHesapla(sepetToplam, 50);  // 150

"Bir fonksiyonun bir şeyi yapmasını bekliyorsak ve o fonksiyon aynı zamanda bir başka şeyi de yapıyorsa, bu yan etkidir. Yan etkiler, kodumuzu tahmin edilemez hale getirir ve karmaşıklığı artırır." - Robert C. Martin (Uncle Bob)

Yan etkisiz fonksiyonlar, özellikle paralel programlama ve test etme süreçlerinde büyük avantajlar sağlar.

4. Kısa ve Odaklı Fonksiyonlar: Özü Yakalayın

Fonksiyonlarınızın boyutu, onların anlaşılabilirliği ve bakımı üzerinde önemli bir etkiye sahiptir. Genellikle, bir fonksiyonun 20-30 satırdan daha uzun olmaması şiddetle tavsiye edilir, ancak bu kesin bir kuraldan ziyade bir rehberdir. Önemli olan, fonksiyonun tek bir işe odaklanması ve bu işi anlaşılması kolay bir şekilde yapmasıdır. Uzun fonksiyonlar genellikle SRP'yi ihlal eder ve birden fazla sorumluluğu üstlenir. Bir fonksiyonu kısaltmanın ve odaklamanın ana yolu, içindeki farklı mantık bloklarını veya adımları ayrı, daha küçük ve kendi başına anlamlı fonksiyonlara bölmektir.

800x400.png


Bu yaklaşım, her küçük fonksiyonun kendi başına test edilmesini kolaylaştırır ve kodun genel yapısını daha modüler hale getirir. Fonksiyonlarınız o kadar küçük olmalı ki, adeta bir paragraf gibi okunabilmeli ve ne iş yaptığını ilk bakışta açıkça belli etmelidir.

5. Parametre Sayısını Minimize Etme: Aşırı Yüklenmeyi Önleyin

Bir fonksiyonun aldığı parametre sayısı, fonksiyonun karmaşıklığı ve kullanım kolaylığı ile doğru orantılıdır. Çok sayıda parametre alan fonksiyonlar (genellikle 3-4'ten fazla), çağrılırken anlaşılması zor olabilir, hatalara daha yatkın hale gelebilir ve imza değişiklikleri durumunda bakım maliyetlerini artırabilir. Eğer bir fonksiyonun çok fazla parametreye ihtiyacı varsa, aşağıdaki stratejileri düşünebilirsiniz:

* Parametre Nesnesi (DTO/POJO) Kullanımı: İlgili parametreleri tek bir nesnede toplayın. Bu, fonksiyon imzasını basitleştirir ve parametrelerin amacını daha net hale getirir.
* Fonksiyonu Bölme: Fonksiyonu daha küçük, daha odaklı parçalara ayırarak her birinin daha az parametre almasını sağlayın.

Kod:
// Kötü Örnek: Çok Fazla Parametre
function musteriKayit(ad, soyad, email, telefon, adresSatir1, adresSatir2, sehir, postaKodu, ulke) {
    // ... kayıt mantığı ...
}

// İyi Örnek: Parametre Nesnesi Kullanımı
class MusteriBilgileri {
    constructor(ad, soyad, email, telefon, adres) { // Adres de kendi içinde bir nesne olabilir
        this.ad = ad;
        this.soyad = soyad;
        this.email = email;
        this.telefon = telefon;
        this.adres = adres;
    }
}

class AdresBilgileri {
    constructor(satir1, satir2, sehir, postaKodu, ulke) {
        this.satir1 = satir1;
        this.satir2 = satir2;
        this.sehir = sehir;
        this.postaKodu = postaKodu;
        this.ulke = ulke;
    }
}

function musteriKayit(musteriBilgileri) {
    // ... kayıt mantığı ...
}

// Kullanım:
const adres = new AdresBilgileri("Cumhuriyet Cad.", "No: 10", "İstanbul", "34000", "Türkiye");
const musteri = new MusteriBilgileri("Ahmet", "Yılmaz", "ahmet@example.com", "5551234567", adres);
musteriKayit(musteri);

Bu yaklaşım, fonksiyon çağrısını daha okunabilir ve genişletilebilir hale getirir. Yeni bir bilgi eklemek istediğinizde, sadece DTO'yu güncellemeniz yeterlidir, fonksiyon imzasını değiştirmenize gerek kalmaz.

6. Sağlam Hata Yönetimi: Hataları Zarifçe Ele Alın

Her fonksiyonun, başarılı bir şekilde tamamlanamadığı durumları nasıl yöneteceğini açıkça belirtmesi önemlidir. Hata yönetimi, fonksiyonun güvenilirliğini ve kararlılığını doğrudan etkiler. Hataları ele almak için çeşitli yaklaşımlar mevcuttur:

* İstisna Fırlatma (Exception Handling): Özellikle programın beklenen akışının dışına çıkan, ciddi hatalar için kullanılır. Fonksiyonun beklenen çıktıyı üretemediği veya bir ön koşulun sağlanmadığı durumlar için idealdir.
* Hata Kodu Döndürme: Fonksiyonun başarı durumunu veya belirli bir hata türünü temsil eden özel bir değer (genellikle null, undefined veya özel bir hata nesnesi) döndürmek. Daha hafif hatalar veya beklenen hata senaryoları için kullanılabilir.
* Geri Çağırma Fonksiyonları (Callbacks) veya Promise/Async-Await: Asenkron işlemlerle çalışırken, başarı ve hata durumlarını ayrı ayrı işlemek için yaygın olarak kullanılır.

Seçtiğiniz yöntem ne olursa olsun, bir fonksiyonun hata senaryolarını önceden öngörmek ve bunları zarifçe ele almak kritik öneme sahiptir. Kullanıcıya veya çağıran koda anlamlı geri bildirim sağlamak, hata ayıklama sürecini büyük ölçüde kolaylaştırır.

7. Kapsamlı Dokümantasyon ve Yorumlar: Geleceği Aydınlatın

Temiz kod, genellikle kendi kendini belgeleyen kod olarak kabul edilir, ancak bazı durumlarda, özellikle karmaşık iş mantığı veya nadir kullanılan algoritmalar söz konusu olduğunda, açıklayıcı dokümantasyon ve yorumlar hayati önem taşır. Fonksiyonunuz için bir 'docstring' veya benzeri bir açıklama bloğu ekleyin. Bu blok şunları içermelidir:

* Fonksiyonun genel amacı ve ne iş yaptığı.
* Beklediği parametreler (türleri, amaçları, kısıtlamaları).
* Döndürdüğü değer (türü, anlamı).
* Fırlatabileceği istisnalar veya özel durumlar.
* Varsa, önemli algoritmik detaylar veya kararların nedenleri.

Yorumları ise, 'nasıl'dan çok 'neden' sorusunu açıklamak için kullanın. Neden belirli bir yaklaşımı seçtiğiniz, neden bir kenar durumu böyle ele aldığınız gibi. Kötü yazılmış, modası geçmiş veya gereksiz yorumlardan kaçının.

Kod:
/**
 * Müşterinin sepetindeki ürünler için nihai ödeme tutarını hesaplar.
 * İndirim kodlarını ve vergi oranlarını dikkate alır.
 *
 * @param {Array<Object>} urunler - Sepetteki ürünlerin listesi, her ürün bir fiyat ve miktar içerir.
 * @param {string|null} indirimKodu - Uygulanacak indirim kodu, yoksa null.
 * @param {number} vergiOrani - Uygulanacak vergi oranı (örn: 0.18 için %18).
 * @returns {number} Toplam ödeme tutarı.
 * @throws {Error} Eğer ürün listesi boşsa veya geçersiz indirim kodu verilirse.
 */
function sepetToplaminiHesapla(urunler, indirimKodu, vergiOrani) {
    if (urunler.length === 0) {
        throw new Error("Sepet boş olamaz.");
    }
    let toplam = urunler.reduce((acc, urun) => acc + (urun.fiyat * urun.miktar), 0);

    if (indirimKodu === "INDIRIM20") {
        toplam *= 0.8; // %20 indirim
    } else if (indirimKodu && indirimKodu !== "INDIRIM20") {
        throw new Error("Geçersiz indirim kodu.");
    }

    return toplam * (1 + vergiOrani);
}

Ek kaynak olarak, yazılım geliştirme dünyasının klasiklerinden biri olan Robert C. Martin'in "Temiz Kod: Çevik Yazılım El Kitabı" kitabı, bu konuda paha biçilmez bilgiler sunar ve her geliştiricinin okuması gereken bir eserdir.

8. Test Edilebilir Fonksiyonlar Yazmak: Güvenilirliği Garanti Edin

Fonksiyonlarınızı yazarken, onların nasıl test edileceğini düşünmek, kaliteli kodun önemli bir göstergesidir. İyi tasarlanmış, saf ve bağımlılıkları en aza indirilmiş fonksiyonlar doğal olarak daha kolay test edilebilir. Unit testler, bir fonksiyonun beklenen girdilerle doğru çıktıyı verip vermediğini ve hata durumlarını doğru bir şekilde ele alıp almadığını doğrulamak için kritik öneme sahiptir. Test edilebilir kod:

* Bağımsızdır: Dış sistemlere (veritabanı, ağ, dosya sistemi) doğrudan bağımlı değildir veya bu bağımlılıklar kolayca taklit edilebilir (mock edilebilir).
* Deterministiktir: Aynı girdilerle her zaman aynı çıktıyı verir (yan etkileri yoktur).
* Küçüktür ve Odaklıdır: Tek bir sorumluluğu olduğu için test senaryoları daha basittir.

Test yazmak, sadece fonksiyonlarınızın doğru çalıştığını garantilemekle kalmaz, aynı zamanda fonksiyonunuzun tasarımını da iyileştirir. Test yazmaya zorlandığınızda bir fonksiyonun karmaşık olduğunu fark ederseniz, bu genellikle daha iyi bir tasarıma ihtiyacı olduğunun bir işaretidir.

Sonuç: Sürekli Gelişim ve Temiz Kod Kültürü

Fonksiyon yazımı, zamanla ustalaşılan bir sanattır ve sürekli pratik, öğrenme ve kod incelemesi gerektirir. Bu ipuçlarını ve prensipleri uygulayarak, sadece daha az hataya sahip, daha güvenilir ve bakımı kolay kod yazmakla kalmayacak, aynı zamanda geliştirme sürecinizi çok daha verimli ve keyifli hale getireceksiniz. Unutmayın, temiz ve sürdürülebilir fonksiyonlar, her başarılı yazılım projesinin temelidir ve teknik borcu azaltmanın, yenilikçiliği hızlandırmanın ve ekip verimliliğini artırmanın anahtarıdır. Kod kalitenize yatırım yapmak, uzun vadede size ve projenize büyük faydalar sağlayacaktır. Başarılar dilerim ve her zaman öğrenmeye ve kodunuzu geliştirmeye devam edin!
 
shape1
shape2
shape3
shape4
shape5
shape6
Üst

Bu web sitenin performansı Hazal Host tarafından sağlanmaktadır.

YazilimForum.com.tr internet sitesi, 5651 sayılı Kanun’un 2. maddesinin 1. fıkrasının (m) bendi ve aynı Kanun’un 5. maddesi kapsamında Yer Sağlayıcı konumundadır. Sitede yer alan içerikler ön onay olmaksızın tamamen kullanıcılar tarafından oluşturulmaktadır.

YazilimForum.com.tr, kullanıcılar tarafından paylaşılan içeriklerin doğruluğunu, güncelliğini veya hukuka uygunluğunu garanti etmez ve içeriklerin kontrolü veya araştırılması ile yükümlü değildir. Kullanıcılar, paylaştıkları içeriklerden tamamen kendileri sorumludur.

Hukuka aykırı içerikleri fark ettiğinizde lütfen bize bildirin: lydexcoding@gmail.com

Sitemiz, kullanıcıların paylaştığı içerik ve bilgileri 6698 sayılı KVKK kapsamında işlemektedir. Kullanıcılar, kişisel verileriyle ilgili haklarını KVKK Politikası sayfasından inceleyebilir.

Sitede yer alan reklamlar veya üçüncü taraf bağlantılar için YazilimForum.com.tr herhangi bir sorumluluk kabul etmez.

Sitemizi kullanarak Forum Kuralları’nı kabul etmiş sayılırsınız.

DMCA.com Protection Status Copyrighted.com Registered & Protected