Temiz Kod: Çiçek Düzeni Part 2
İçindekiler
Önceki yazımda değişkenlerin ve fonksiyonların temiz bir görünüme sahip olması için kullanabileceğiniz birkaç ipucu vermiştim. Çicek düzeninin en temel unsurlarından olan kod içerisindeki yorum satırları ve formattan da bu yazımda bahsedeceğim. Kodunuzun başka geliştiriciler tarafından, hatta kodu yazdıktan bir süre sonra kendinizin okuyabilmesi için önemli olan bu iki unsurun kafanızda iyiiiceee yer etmesi lazım! Lafı çok uzatmadan, hemen başlayalım.
Yorum Satırları
Kendinizi Yorum Satırlarıyla Değil Kodda Açıklayın!
Kod yazıyorsunuz!! Çok fazla yorum satırıyla kodu boğmak yerine mantıklı isimlendirmeler yaparak kendinizi açıklayın.
Legallik Belirten Yorumlar
Bilgilendirici Yorumlar
Kodu okuyan kişiler için, sizin bakış açınıza sahip olabilmeleri için kısa bilgi yorumları yazabilirsiniz.
Neden Bildiren Yorumlar
Bazen yazdığınız yorumlar sadece bilgilendirme amaçlı olmayabilir. Bir kod bloğunu neden yazdığınızı, yazarken kullandığınız mantığı açıklamak için de yorum satırlarını kullanabilirsiniz.
Yapılacaklar Yorumları
Kodunuzun içerisinde kısa dönemli olarak yapacağınız şeyleri hatırlamak, fonksiyonların durumu için yorum satırları kullanabilirsiniz.
KÖTÜ (kötü!) Yorumlar :/
Uzayıp Giden Sonu Gözükmeyen Yorumlar
Editör çerçevesine sığmayıp sağa doğru kayan yorumlardan kaçının! Kodun kendisini okumaktan daha uzun sürüyor bu tip yorumları okuması 🙁
Kod Dosyasında Günlük Tutmak
Aşağıdaki gibi bir şey yapmak yerine GIT kullanabilirsiniz…
Gürültü Yaratan Komutlar
Ne iş yapacağı bariz olan bir kod satırı için yorum satırı kullanmayın.
Kod Formatı
Kod formatı yazdığınız kodun okunurluğunu OLDUKÇA FAZLA etkiler, çoğu zaman da geliştiriciler tarafından göz edilir. Hatta kendi yazdığımız koddaki formata hiç dikkat etmeden önümüze başka bir geliştiricinin yazdığı kod gelince de “Formata bak ya, kafamı klavyeye sürsem daha düzgün yazardım peh!” demekden de pek geri kalmayız açıkçası 🙂
Tabi ki kodunuzun çalışması önemsiz demiyorum burda, öncelikle çalışması lazım! Yalnızca çoğu zaman fonksiyonelliğe kafamızı o kadar takıyoruz ki, neyi nerde yaptığımızı ve ne yaptığımızı unutuyoruz. Bunun için kendimce geliştirdiğim çözüm, çok uzun bir kod yazıyorsanız en azından bloğu yazmayı bitirdiğinizde “Ben ne yapmışım ya burda?” diye bakmanız. Sonrasında formatta gördüğünüz hataları, açıklamak istediğiniz şeyleri istemsiz ekliyorsunuz zaten 🙂 Peki “Nedir bu format mevzusu?” ya da “İstemsiz olarak ne ekleyeceğim, ne düzelteceğim?” sorusu hemen oluşmuştur kafanızda. Hemen bunlara da göz atalım!
Noktalı Virgül
Hala unutanamız kaldı mı ya?
Karşılaştırma Ve Eşitlik Operatörleri
==, != yerine === ve !== kullanın.
Bloklar
Birden fazla satır içeren bütün bloklara parantez koyun. Eğer parantezleri if ve else bloklarında kullanıyorsanız, if‘in bitiş parantezini else‘in olduğu satıra koyun.
Camel Case Ve Pascal Case
Değişken, obje ve fonksiyon isimlendirirken camel case kullanın.
Constructor ve sınıf isimleri verirken pascal case kullanın.
Böylelikle temiz kod yazımla alakalı temel bilgileri beraber gözden geçirmiş olduk. Temiz yazım, oldukça büyük bir konu olduğundan çok aşırı gerekli görmediğim(ufak tefek bir sürü kural var, hepsini bende öğrenemedim henüz :D) bazı kuralları yazı dışı bıraktım. Umarım, yazılarım kodlarınızda udak değişikliklere, gelişmelere sebebiyet verebilmiştir. Bir sonraki yazımda görüşmek üzere, keyifli kodlamalar!
