Sayfalar

24 Şubat 2019

Daha Temiz Kod için Code Review Notları

Daha Temiz Kod için Code Review Notları

Code Review: Kod inceleme veya Kod gözden geçirme işlemine denir. Kod kalitesini artırmak çin yapılır. Özellikle performans problemi olan yazılımlarda yapılması gerekir.

Daha temiz ve anlaşılır bir yazılım mimarisi kurmak ve sonra gelen Developer'lar için de bunun devam ettirilmesini sağlamak için temiz ve anlaşılır kodun önemi mühimdir. Bugün birçok yazılım dilin başta Java ve Visual C# olmak üzere mimari projelerde bu çalışma Architect tarafından yapılarak projenin daha performanslı ve geleceğe dönük devam ettire bilirliğini sağlıyor.

• Bir Metod 40 satırdan fazla olmamalıdır. 40 satırdan fazla ise incelenmelidir, dallanan kısımlar varsa bakılmalıdır, gereksiz dallanma olmamalıdır.

• Mecbur kalmadıkça VAR değişkenini kullanmayın. String, Int veya Object gibi asıl değişken ne ise onu kullanmanız yararlı olacaktır.

• Sınıf(Class) ve metotların belirlenen tek bir sorumluluğu yerine getiriyor olması gerekir.

• Kritik kod blokları için Try-Catch kullanımı ve boş Catch blogunun olmadığına emin olunmalıdır.

• Sınıflar içerisine eklenmiş fakat kullanılmayan isim uzayları (namespaces) kaldırılmalıdır.

• Sabitlerin const olarak tanımlandığına, parametrik olabilecek yerlerin parametrik hale getirildiğine emin olunuz.

• Çok fazla açıklama yer alıyorsa bunlar kısaltılmalı hatta metot seviyesinde değil sınıf seviyesinde kod açıklaması yapılması önerilmelidir.

• Sınıf geliştirmeye açık modifikasyona kapalı olmalıdır.

• Kod Changset yaparken Algoritmik değişiklik ile Okunabilirlik(Kod Düzenleme) değişikliğini aynı anda yapıp Check-In yapmayın. İkisini ayrı yapın ki bir önceki kodla Compare etmesi ve kontrolü daha rahat olsun.

• Mimariniz de kalıtım dengesini iyi kurmalısınız. Bu ağaç yapısında en Core alana ulaşılan katmana kadar her katman bir sonrakini desteklerken aynı zamanda üst katmanlara bağımlı olmamalıdır. Çünkü Core katmanı çıkarıp aldığımızda başka bir proje adı ile yine o Framework'ü kullanarak devam ettirebilmeli.

Burak AVCI