Temiz Kodlama: Çicek Düzeni!

Yazılıma ilk başladığımda, benden daha tecrübeli olan arkadaşımla beraber oldukça kolay bir Python kodu yazıyorduk. Kendim bir süre (belki olması gereken daha uzun bir süre) uğraştıktan sonra algoritmayı koda düzgün bir şekilde uygulayıp konsol üzerinde almak istediğim çıktıyı alabilmiştim. Heyecanlı bir şekilde arkadaşıma yaptığım işi gösterdiğimde ise, kendisinin ilk tepkisi suratını ekşitmek olmuştu.

“Ya tamam, kodun çalışıyor da okunmuyor ki!” demişti ardından. İlk başta kendisini anlayamamıştım. Yazılıma alışkın olmayan gözlerim editördeki kodu taradığı zaman, yanlış olan hiçbir şey tespit etmemişti. Basitçe “dümdüz yazı bu, nasıl okuyamıyor acaba?” diye düşünmüştüm. Tabi ki ortada büyük bir sıkıntı vardı çünkü çok büyük bir ihtimalle o an dosya tam olarak bir kaos içerisindeydi.

Arkadaşım, dosyayı düzeltmeye başladı. Tonla değişken ismi değiştirdi, parantezlerin yerleri değişti. Takip etmekte zorlandım ve neyi neden yaptığını açıkçası fazla anlamadım. İşi bitince arkasına yaslandı ve dedi ki “İşte bak! Çiçek gibi düzen, neyin ne olduğunu anlayabiliyorsun sonunda!” dedi gururla. Tam olarak o andan sonra “Çiçek Düzenini” kafama taktım ve kendimi temiz kodlama için eğitmeye başladım. Bu yazımda da sizlerle JavaScript dosyalarını temiz yazmak için öğrendiğim bir iki püf noktayı paylaşmak istiyorum ki, hepimiz kirli kokulu kodlardan kurtulalım 🙂

JavaScript İçin Temiz Yazım:

Anlamlı İsimler

Bir değişkeni neden kullandığınızı net bir şekilde anlatan değişken isimleri kullanın.

Yanlış İsimlendirme

Verdiğiniz değişken isimleri, yanlış bilgilendirme içermesin ve açık olsun.

Aranabilir İsimler

Karmaşık ve uzun kodlarınızda eski yazdığınız bir fonksiyona ya da değişkene geri dönmek isterseniz, verdiğiniz ismin akılda kalıcı olmaması nedeniyle bütün kodunuzu taramak zorunda kalabilirsiniz. Bu nedenle akılda kalıcı ve araması kolay isimler kullanmaya özen gösterin.

Orijinal Olmaya Çalışmayın 🙁

Evet, hepimiz canımızın sıkıldığı o noktada izlediğimiz filmlerden alıntı yaparak isimlendirme yapmak istiyoruz. Maalesef ki herkes yaptığımız göndermeyi anlayamayabilir..

Fonksiyonlar

Tek Bir Fonksiyon İçerisinde, Tek Bir Şey Yapın (Birimiz, Hepimiz İçin Ama; Birimiz, Birimiz İçin :D)

Tek bir şey yapın derken, fonksiyonları bölüp parçalamaktan daha çok, mantıklı yapılandırmalar yapın. Örneğin bir işi yaparken ortak kısımları olan fonksiyonları bir çatı altında(abstraction) toplayabilirsiniz. Bu bütünleştirmeyi yaparken, adım adım gidip sadece tek seviye abstraction yaparsanız fonksiyonunuz daha okunaklı olacaktır.

Açıklayıcı İsimler

Aynı değişkenlerde olduğu gibi, fonksiyonlarda da açıklayıcı isimler kullanmak; sonradan bakıldığında fonksiyonun içine bakmadan ne iş yaptığını anlayabilirsiniz.

Fonksiyon Girdileri(Arguments)

Fonksiyonlarda kullanılması gereken ideal çıktı sayısı sıfırdır. Ardından bir ve iki girdili fonksiyonlar gelir. Üç girdili fonksiyonlardansa olabildiğince uzak durmalısınız!

Girdi olarak obje kullandığınızda, fonksiyona bilgileri teker teker girmek yerine tanımlamış olduğunuz objenin alanlarından verileri alabilirsiniz.

Kendinizi Tekrar Etmeyin

Javascript ile alakalı birçok temiz kod uygulaması var. Bu yazımda sizlere değişkenlerden ve fonksiyonlardan bahsettim. Bir sonraki yazımda ise kod formatından ve yorum satırlarından bahsedeceğim! Atladığımbir konu varsa yorumlar kısmına yazabilirsiniz, okuduğunuz için teşekkürler. Keyifli kodlamalar!