PHP Kod Parçasını Temizleyin

Biçimlendirme okuyucuya neden yardımcı olur

İnsanlar kodu biçimine bakarak okur. Süslü parantezler hizalı olduğunda ve her ifade kendi satırında durduğunda okuyucu tek kelime okumadan yapıyı görür. Bir gözden geçiren kişi eksik bir parantezi ya da yanlış yere konmuş bir döngüyü fark edebilir. Düz bir metin bloğu bütün bunları gizler.

Önce ve sonra

Bir günlük dosyasından kopyalanan orijinal kod:

<?php function total($items){$sum=0;foreach($items as $item){$sum+=$item["price"];}return $sum;}

4 boşlukla temizlenmiş hali:

<?php function total($items)
{
    $sum=0;
    foreach($items as $item)
    {
        $sum+=$item["price"];
    }
    return $sum;
}

Paylaşmadan önce kısa kontrol listesi

• Gizli bilgileri kaldırın. Buraya yapıştırdığınız metin sunucumuzda işlenir, bu yüzden gerçek kimlik bilgilerini, belirteçleri ya da müşteri verilerini kullanmayın.
• Örneği sorunu göstermek için gereken satırlarla sınırlı tutun.
• Hangi PHP sürümünü kullandığınızı ve ne beklediğinizi belirtin.
• Biçimlendirilmiş kodu orijinaliyle karşılaştırın. Araç yalnızca yerleşimi değiştirir, ancak yorumlar ve dizgiler boşluk kurallarından etkilenebilir.
• Girintilerin korunması için sonucu bir kod bloğunun içine koyun.

Bu aracın yapmadıkları

Hata bulmaz, kodunuzu çalıştırmaz ve stil kurallarını denetlemez. Temiz bir yerleşim sorunu görmeyi kolaylaştırır ama çözmez.

Nerede işe yarar

• Bir kod örneği içeren destek talebi ya da hata raporu.
• Bir geliştirici forumunda ya da sohbet kanalında soru.
• Bir örneğin düzenli görünmesi gereken dokümantasyon sayfası ya da eğitim.
• Bir işlevin bölümünde değişiklik önerdiğiniz gözden geçirme yorumu.

Bu durumların hepsinde okuyucu önce yapıyı, sonra sorunu görür. İstenen sıra da budur.

Örneği dürüst tutun

Daha temiz bir yeniden yazım yerine, gerçekten paylaşacağınız kodu biçimlendirin. Örneğin sığması için değişken adlarını kısaltıyor ya da satır çıkarıyorsanız, kısaltılmış sürümü önce kendiniz çalıştırın. Sorunu yeniden üretmeyen şık bir parça, okuyucunun zamanını boşa harcar. Beklediğiniz sonuç hakkında bir not ekliyorsanız, bunu kod bloğunun üstüne sade bir dille yazın.