Temiz Kod nedir?
Temiz Kod , ne anlama geliyor?
“Temiz Kod” terimi yeni başlayanlar için kafa karıştırıcı olabilir. Bu ne demek? Arabayı temizledin, odanı temizledin, kodunu nasil temizlersin?
Temizlemenin neredeyse tam tersini düşünerek başlayalım. Dağınık bir oda hayal edebiliyorsunuz ve eminim dağınık kodu da hayal edebileceğinizden eminim. Karışık kodları düşündüğümde, çok sayıda kod satırını, kötü adlandırılmış değişkenleri, birden çok sınıfı aynı dosyada ve benzeri şekilde düşünüyorum.
Temiz kodun faydaları nelerdir?
Temiz kodu yazarken birçok avantajları vardır, bunlardan bazıları şunlardır:
- Anlamak daha kolaydır.
- Kodun ne yapacağını anlayabilirsiniz.
- Onu 6 ay sonra geri döndüğünüzde bile anlayacaksınız.
- Bunu başkaları da daha kolay anlamış olacak.
- Korunması daha kolay olacak.
- Test etmek daha kolay olacak.
Temiz kod yazmak için ne yapabilirim?
Temiz kod yazmaya yönelik yapabileceğiniz başlıca şeylerden bazıları:
-
Değişkenlerinize, metodlarınıza ve sınıflarınıza anlamlı isimler verin.
Müşteri tarafından id alan bir metodunuz varsa, bunu ‘GetCustomerById’ olarak adlandırın ve parametreyi ‘id’ veya ‘customerId’ olarak adlandırın.
-
Metodlarınızı ve sınıflarınızı çok fazla yapmayın.
Main metodunun yanı sıra, sınıflarınızın ve metodlarınızın her birinde yalnızca bir şey yapmasını hedeflemelisiniz. Bu şekilde bakım, test etme ve anlama daha kolaydır.
-
Biçimlendirme
Beyaz boşluğu etkili bir şekilde kullanın. Kodunuzun belirli bir bölümünün öne çıkmasını istiyorsanız, bunun üstünde ve altında boş bir satır bırakın.
Bir sınıfa yeni metodlar eklerken altına ekleyin. Dosyadaki tek değişiklik, onu barındıracak şekilde aşağıya doğru ilerleyen satırların değil, alttaki kodun eklenmesi olarak kod incelemelerinde yardımcı olur.
-
Metodun içinde yorum yazmayın
Kodun ne yapacağını açıklamak için metodunuzda yorum yazmanız gerektiğini düşünüyorsanız, muhtemelen bu kod için bir metod oluşturmanız ve anlamlı bir ad vermeniz gerekir, örn. SendEmailToCustomer ()
Temiz kod yazma hakkında daha fazla bilgi nasıl öğrenebilirim?
Temiz kod yazmayı öğrenmenize yardımcı olmak için internette bazı mükemmel kaynaklar var. İşte bunlardan bazıları: