Türkiye’de her önüne gelenin yazılımcı olduğu günümüzde, temiz kod yazan kaç kişi diye sorsak, herhalde yazılımcı diye geçinenlerin çok büyük bir kısmı temiz kod yazmaktan bir haber insanlardır. C# Kodlama…
İster ekip çalışmasında, isterseniz tek başınıza kod geliştirirken, bence ve bir çok yazılımcı için olmazsa olmaz kurallar vardır. Bunlar C# kodlama standartlarıdır. Türkçe kaynak bulmanın artık kolay olduğu günümüzde, bir takım arkadaş güzel bir çalışma yaparak, bir PDF dokümanı oluşturmuşlar.
Amerika’yı yeniden keşfetmeye gerek yok, aynı şeyleri burada yazacağıma, arkadaşların yapmış olduğu PDF dokümanını paylaşıyor olacağım. Bundan önce ben de ufak tefek bir kaç örnek vermek istiyorum.
İsimlendirmeler
İsimlerdirmeler belki de yazdığınız kodların en önemli elemanlarından biridir. İsimlendirme de 2 farklı yöntem uygulanıyor Pascal Casing ve Camel Casing, bunları tercihinize göre yaparsanız her zaman bir adım önde başlarsınız. Benim tercihim Camel Casing olmaktadır.
Pascal Casing: Kelimelerin ilk harfleri büyük geri kalan harfleri küçük yazılır.
Örnek: FirstName
Camel Casing: İlk kelimenin ilk harfi hariç kelimelerin baş harfleri büyük diğer harfler küçük yazılır.
Örnek: firstName
Ayrıca, ASPx elementlerinde aşağıdaki kısaltmalar kullanılır. Mesela sürükle bırak ile bir Label web form üzerine bıraktınız, default olarak ismi “Label1” dir. Bu label bir ürün ismini temsil edecekse yazılması gereken “lblproductName” dir.
Kontrol | Prefix |
Label | lbl |
TextBox | txt |
DataGrid | dtg |
Button | btn |
ImageButton | imb |
Hyperlink | hlk |
DropDownList | ddl |
ListBox | lst |
DataList | dtl |
Repeater | rep |
Checkbox | chk |
CheckBoxList | cbl |
RadioButton | rdo |
RadioButtonList | rbl |
Image | img |
Panel | pnl |
PlaceHolder | phd |
Table | tbl |
Validators | val |
Kısa Kısa bilgiler
- Yorum satırları için // veya /// işaretlerini kullanın. /*…*/ işaretini kullanmayın, bunu sadece CSS içinde kullanmaya çalışın.
- Yazılan her kod için yorum satırı eklemeyin. Yorum eklerken, Türkçe karakter kullanmamaya gayret edin, noktalama işaretleri düzgün yorumlar yazın.
- Hataları yakalamak için try-cache kullanın, düzgün Exception’ları denetleyin, ayrıca bunları log4net tarzı kütüphanelerle kayıt altına alın.
- Gerekli yerlerde break-point ekleyin ve kodunuzu analiz edin.
- Her zaman çok katmanlı (N-Tier) mimariyi tercih edin.
- Veritabanı bağlantılarını arayüzün bulunduğu katmandan (UI ) yapmayın. Her zaman veritabanı işlemlerini ve ilişkilerini barındıran bir veri erişim katmayı oluşturun, ileride veri tabanınızı değiştirdiğinizde sorun olmasın.
C# Standartlarıyla ilgili Türk yazılımcılar tarafından geliştirilen PDF’i buradan indirebilirsiniz.