İyi kod yazmanın özellikleri şu şekilde olmalıdır:

  • Güvenilir ,
  • Sürdürülebilir  yani bakımı kolay olmalıdır.
  • Verimli olmalıdır.

Eğer projelerimizde uzun süreli verimlilik ve performans sağlamak istiyorsak önce kodun verimliliğine önem vermemiz gerekmektedir. Eğer yazdığımız kod sürdürülebilir değilse  ilerleyen zamanda sorunların tespiti biraz daha fazla zaman alıcı olacaktır ve bunun sonucunda artan mesailer görülecektir.

İsimlendirme Standartları

Kodlama yaparken alan, özellik, sınıf gibi yapıların isimlendirmelerini yaparken dikkatli olmamız gerekmektedir. Bununla ilgili bazı kavramlar mevcut:

Pascal Casing: Kelimenin ilk harfi büyük geri kalan harfleri küçük yazılır. Örneğin:  ‘ DenemeAlan ’ gibi.

Camel Casing: İlk kelimenin ilk harfi hariç kelimelerin baş harfleri büyük diğer harfler küçük yazılır. Örneğin: ‘ denemeAlan ’ gibi.

  • Sınıflandırmada Pascal Casing kullanılmalıdır.

  public class HelloWorld
{
//Do something
//…

}

  • Metod adlandırmada Pascal Casing kullanılmalıdır.

Void SayHello(string name)
{
//Do something
//…
}

  • Değişken isimlerinde ve metod parametrelerinde Camel Casing yöntemi kullanılır.
  • Arayüz (Interface) isimlendirmelerini yaparken “I” ön eki kullanılmalı (Örneğin: IDeneme)
  • Değişkenler için anlamlı ve açıklayıcı kelimeler kullanın. Kısaltmalar kullanılmamalıdır.
    • İyi kod : string adres
      int  maas
    • Kötü kod: string nam
      string addr
      int sal
  • Değişken isimleri C# anahtar kelimelerine benzeyecek şekilde seçilmemelidir.
  • Mantıksal (boolean) değişkenlerin önünde (is) veya benzer ön ekler kullanın (örneğin: private bool isFinished)
  • UI elemanlarını birbirinden ayırabilmek için uygun bir örnek kullanın.

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

  • Sınıfların bulunduğu fiziksel dosya isimleri sınıf ismi ile aynı olmalıdır. Örneğin : HelloWorld sınıfı için dosya adı cs veya HelloWorld.cs olabilir.
  • Dosya isimleri için Pascal Casing kullanılır.

    GİRİNTİLER  VE ARALIKLAR
  • Girinti yapmak için TAB tuşu kullanılmalı ve yorum satırları kod satırlarıyla aynı hizada olmalıdır.
         İyi Kod: 

Kötü kod :

  • Gruplandırdığınız kod blokları arasında bir satır boşluk bırakın.
  • Sınıf içinde her bir metod arasında sadece bir satır boşluk olmalıdır.
  • Visual Studio da bozulan satır hizalamalarını veya girdileri (CTRL + K + D) tuş kombinasyonu kullanarak otomatik düzeltebiliyoruz.
  • Süslü parantezler if, for gibi kodlarla aynı satırda olmamalı ayrı bir satırda olmalıdır.
  • Her operator ve parantezden önce bir boşluk bırakın.
  • Birbiri ile alakalı kod parçalarını guruplamak için #region kodunu kullanın. Bu kod arasında kalan kodları kapatarak saklamak mümkündür.


    DOĞRU  PROGRAMLAMA  TEKNİKLERİ
  • İçeriği çok uzun olan metodlar yazmayın. Bir metod 1 – 25 satır arası uzunlukta olmalıdır. Eğer 25 satırdan uzun bir metodunuz varsa bunu alt metodlara bölmelisiniz.
  • Metod isimleri metodun ne iş yaptığını anlatır nitelikte olmalıdır. Niyeti belli etmeyen yanıltıcı isimler kullanmayın. Metod ismi açıklayıcı şeklide seçilirse metodun ne iş yaptığını belirten yorum satırları yazmamıza gerek kalmaz.

Bir Cevap Yazın

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