İyi Bir Yazım ve Okunurluk İçin

Programcılar, kodun okunabilir ve düzenli olmasını sağlamak için çok sayıda taktik kullanır. Bunlar şunlardır.

1. Değişken İsimlendirme

   • Pascal Tipi (PascalCase): Değişkenin her kelimesi büyük harfle başlar, diğerleri küçük yazılır. Örnek: PascalYazimGelenegi = 'Pascal tipi yazım geleneği';

   • Deve Tipi (CamelCase): Değişkenin ilk kelimesi küçük yazılır, diğerleri büyük harfle başlar ve küçük yazılır. Örnek: deveYazimGelenegi = 'Deve tipi yazım geleneği';

   • Yılan Tipi: Değişkenin her kelimesinin arasına alt tire konur ve küçük yazılır. Sabitler büyük yazılır. Örnek: yilan_yazim_gelenegi = 'Yılan tipi yazım geleneği';

   • Macar Gösterimi: Değişken isimlendirmeye ilk başta veri tipi kısaltması ile başlanır ondan sonrası Pascal Tipi olarak devam eder. Sabitler büyük yazılır. Örnek: sMacarGosterimGelenegi = 'Macar gösterimi yazım geleneği';

2. Yazım, Boşluk, Sekme

   • İfadelerin sonunda noktalı virgül kullan,

   • Satırları uzun tutma (En fazla 80-120 karakter),

   • Süslü parantezlerden önce bir boşluk bırak,

   • Deyimlerden sonra (if, else, for vb.) bir boşluk bırak,

   • Operatörlerin (=, +, -, <, >, vb.) sağında ve solunda boşluklar bırakarak okunur yap,

   • İç içe yapılarda girinti (Indentation) yap (İki boşluk veya Tab),

   • Satır içindeki iç içe ifadelerde parantezlerden önce ve sonra boşluk bırak,

   • Mantıksal ifadelerden önce boş bir satır bırak,

   • 'Değilse (Else)' deyimini boşluk bırakmadan süslü parantezle aynı satırda yaz,

   • Fonksiyon-parantez-ilk parametre arasında boşluk bırakma,

   • Parametreler ve argümanlar arasında bir boşluk bırak.

3. Yorum Ekleme

   • Yorumlar, derleyicinin yok saydığı, kodu etiketlemek için yararlı olan kod bölümleridir.

   • Kodun bakımı veya güncellenmesi için en önemli ayrıntıdır.

   • Kodu bölümlere ayırmak için yorumlar eklenir.

   • Kritik olduğu düşünülen yerlerde (döngüler, fonksiyonlar, bloklar vb.) kodun neye yaradığı, kapsamı, beklenen sonuçları yorum olarak eklenir.