C# Kodlama Standartları

Eğer kaliteli bir yazılımcı olmak istiyor, kaliteli projeler geliştirmek istiyorsanız genel standartları bilmeli ona göre davranmalısınız. Çünkü zaman sonra projenize tekrar döndüğünüzde kodlarınızı rahat okuyabilmeli, isimleri rahat anlayabilmelisiniz.

Hele bir ekiple çalışıyorsanız kodlarınızın okunabilir, rahatça anlaşılabilir olması için bir standartın olması zorunludur.

Peki bu kodlama standartlar nelerdir?

Aslında kodlama standartlarından kastedilen değişkenlere, sınıflara, metotlara verilecek isimlerin nasıl olması gerektiğidir. Veritabanı işlemlerin nasıl yapılacağı, tabloların/gridlerin nasıl doldurulacağı, sınıfların nasıl oluşturulacağının bilinmesidir. Tabi bu standartlar evrensel standart değildir. Ancak çoğunlukça kabul gören, tercih edilen standartlardır. Tek çalışıyorsanız kendinize özgü, ekip olarak çalışıyorsanız ekibe özgü kodlama standartı oluşturabilirsiniz.

Şimdi bir kaç başlıkla iyi ve kötü kodlama standart örneği verelim.

İsimlendirme.

İsimlendirirken “Pascal Casing” standartlarına uymalıyız. Buna göre sınıf ve metotlarda her kelimenin ilk harfini büyük ve bitişik yazmalıyız. özellik (Properties) ve değişken gibi tanımlarda ise ilk kelime tamamen küçük harf ile diğer kelimelerin ise ilk harfi büyük olacak şekilde tanımlamalıyız. Türkçe karakter kullanmamalıyız. Çünkü kodlarımız Türkçe dil desteği sağlamayan bilgisayarlarda sıkıntı çıkarabilmektedir. Bunun yerine “ç” için “c”, “ş” yerine “s”, “ı” yerine “i”, “ğ” yerine “g” gibi harfleri kullanmalıyız.

Aşağıda “Pascal ve Camel Casing” standarlarına uygun örnekleri inceleyebilirsiniz.

Örnek :

İsimlendirme de mümkün oldukça kısaltma kullanmayınız. Aynı ismi vermeniz gerektiğinde numaralandırabilirsiniz. Değişkenin, metodun veya sınıfın işlevini açıklayan bilgi veren isimlendirme yapınız. Hiçbir zaman “-“,”_”,”@!’#$&*()” gibi karakterler kullanmayınız.

Kontrol İsimlendirme

TextBox, Button gibi nesnelere isim verirken ön ek olarak aşağıdaki tabloyu kullanabiliriz.

Örnek : btnKaydet, txtAdiSoyadi gibi. Bu size code bheind ekranında iken nesnenin ne olduğu hakkında bilgi verir.

Girintiler Oluşturun

Kodlarınız arasına blokları belirlemek için tab ile girintiler oluşturun. Eğer Visual Studio da yazıyorsanız menüden Edit > Advanced > Format Document ile (Kısayolu Ctrl+K,Ctrl+D) girintileri düzeltebilirsiniz. Bir sonraki yazımda bu menü tanıtımını okuyabilirsiniz.

İyi:

Kötü:

Boş Bırakın

Değişkenler arasında, blok deyimlerinde, değişkenler, operatörler ve parametreler arasında boşluk bırakın.

İyi:

Kötü:

İyi:

Kötü:

Yorumlar Yazın :

Ne kadar profosyonel olursanız olun kodlarınıza yorumlar ekleyin. Bu daha sonraki kontrollerinizde veya başka ekip üyesinin incelemesinde yardımcı olacaktır. Yorumlarınız çok detaylı ve çokta kısa olmamalıdır.

Güzel kodlamalar dilerim.
Kaynak: Kadir Çamoğlu – Kodlama standartları

Bir Cevap Yazın

E-posta hesabınız yayımlanmayacak. Gerekli alanlar * ile işaretlenmişlerdir