Kodlama standartları belirlemek ve Kod review etmek
Bazı örnekler ile C# .NET kodlama standartları:
Kullanılacak Dil ve Framework Sürümleri: Hangi C# dil sürümünün ve .NET Framework sürümünün kullanılacağı belirtilmelidir.
Adlandırma Kuralları: Değişken, metot, sınıf, enum ve diğer yapıların adlandırılması için belirli kurallar oluşturulmalıdır. Örneğin, değişkenlerin küçük harfle başlaması, metotların fiil formunda adlandırılması, sınıfların PascalCase olarak adlandırılması gibi.
Kod Biçimlendirme Kuralları: Kod biçimlendirme, okunabilirliği artırmak için önemlidir. Belirli kurallar, girinti, boşluk, süslü parantezlerin kullanımı gibi biçimlendirme özelliklerinin standartlaştırılmasına yardımcı olur.
Özellik Yönetimi: Sınıfların ve metotların özellikleri (properties) için belirli kurallar oluşturulmalıdır. Özelliklerin erişim düzeyleri, alanların tanımlanması ve özelliklerin işlevleri gibi.
Hata Yakalama: Hata yakalama, uygulamaların kararlılığı için önemlidir. Belirli hata yakalama standartları oluşturmak, uygulamanın beklenmedik durumlara karşı daha iyi hazırlanmasına yardımcı olur.
Dokümantasyon: Kodların okunabilirliği ve anlaşılabilirliği için belirli dokümantasyon standartları oluşturulmalıdır. Bu, kodun ne yaptığını ve nasıl çalıştığını anlamak için yararlı olacaktır.
Genel Kurallar:
Kod, anlaşılabilir, okunaklı ve tutarlı olmalıdır.
Değişken, sınıf, metot ve diğer yapıların adlandırması açıklayıcı ve anlamlı olmalıdır.
Kodlarda belirli bir biçimlendirme standartı kullanılmalıdır.
Kullanılmayan kod blokları ve yorumlar temizlenmelidir.
Sınıf Kuralları:
Sınıflar PascalCase ile adlandırılmalıdır.
Sınıf alanları, özellikleri ve metotları private olarak tanımlanmalıdır ve ancak ihtiyaç duyulduğunda public olarak tanımlanmalıdır.
Constructor, finalizer ve diğer özel metotlar, sınıfın üstünde yer almalıdır.
Sınıfın mantığına göre, uygun arayüzler (interface) kullanılmalıdır.
Metot Kuralları:
Metotlar fiil şeklinde adlandırılmalıdır.
Metotların parametre sayısı, azami 3 olmalıdır.
Metotların karmaşıklığı düşük tutulmalıdır.
Metotlar try-catch blokları ile hatalara karşı korunmalıdır.
Değişken Kuralları:
Değişkenler küçük harfle başlamalıdır.
Değişkenler, açıklayıcı ve anlamlı olmalıdır.
Global değişken kullanımı, mümkün olduğunca minimum seviyede tutulmalıdır.
Değişkenlerin erişim düzeyleri, ihtiyaç duyulduğunda sınırlanmalıdır.
Yorum Kuralları:
Kodda açıklama, okunaklılığı ve anlaşılabilirliği artırır.
Kodda açıklama yaparken, açıklayıcı ve anlamlı olmalıdır.
Kodun anlaşılması için açıklama yapmak, kodun okunabilirliğini artırır.
Exception Kuralları:
Hata yakalama try-catch blokları ile yapılmalıdır.
Catch bloklarında, hatanın nasıl düzeltileceğine dair açıklama yapılmalıdır.
Exception fırlatma, mümkün olduğunca minimum seviyede tutulmalıdır.
Kod ile Örnekler:
Kod Review:
Kod inceleme (code review), yazılmış olan kodun, kalite, okunabilirlik, performans ve güvenlik açısından gözden geçirilmesidir. Kod inceleme, kod kalitesini artırmak ve hataları erken aşamada tespit ederek maliyeti azaltmak için önemlidir. İşte bir kod inceleme metodolojisi örneği:
Planlama: Kod inceleme yapacak olan kişilerin belirlenmesi ve kod inceleme için zaman ayrılması gerekir. İnceleme süreci için bir zaman çizelgesi belirlenmeli ve bu plana uyulmalıdır.
Hazırlık: Kod inceleme öncesinde, kodu yazan kişinin, kodu açıklamalarla birlikte temizlemesi gerekmektedir. Kod temizlendikten sonra, kod inceleme yapacak kişilere, inceleme yapacakları kodun bir kopyası sağlanır.
İnceleme: İnceleme süreci başlar ve kod inceleme ekibi, kodu adım adım gözden geçirir. Kod inceleme sürecinde, aşağıdaki adımlar izlenir:
a. Kod kalitesi: Kod kalitesi standartlarına uyulup uyulmadığı kontrol edilir. Bu adımda kodun okunabilirliği, sürdürülebilirliği, test edilebilirliği, yeniden kullanılabilirliği ve tutarlılığı kontrol edilir.
b. Performans: Performans açısından kodun uygun olup olmadığı kontrol edilir. Bu adımda, kodun optimize edilip edilmediği, zamanlama açısından sorunlu yerlerin tespiti gibi kontrol edilir.
c. Güvenlik: Güvenlik açısından kodun güvenli olup olmadığı kontrol edilir. Bu adımda, kodun olası güvenlik açıklarının tespiti gibi kontrol edilir.
d. Hata Ayıklama: Hata ayıklama açısından kodun test edilebilir olup olmadığı kontrol edilir. Bu adımda, kodun, beklenmeyen hatalara karşı test edilmesi, hataların tespiti ve giderilmesi sağlanır.
İzleme: İnceleme sürecinin sonunda, kod inceleme ekibi, bulunan hataların ve önerilerin bir rapor halinde düzenlenmesi ve kaydedilmesi gerekir. Bu rapor, kodun daha sonra tekrar incelenmesi veya sorunların giderilmesi için kullanılabilir.
Kod inceleme metodolojisi, farklı şirketler ve ekipler tarafından farklı şekillerde uygulanabilir. Ancak, bu adımlar, bir kod inceleme sürecinin genel hatlarını oluşturur ve uygulanması, yazılan kodun kalitesini artırmak için önemlidir.