C# Kodlama Standartları |

Merhabalar yeni bir yazı ile yine karşınızdayım.Yeni bir yazı dizisine başlıyoruz.Uzun soluklu bir yazı olacak sıkmaması açısından 2’ye bölebilirim.Duruma göre diğer diller içinde aynı yazı dizisinden devam etmeyi planlıyorum.Şimdi gelelim asıl konumuz olan “Kodlama standartları“na.
Yazılım dünyasında bir proje üzerinde tek başına çalışıyorsanız tüm kodları ve düzeni kendi kafanızda kurguladığınızdan problem yaşamayabilirsiniz, problem yalnızca kodlarınızı yazdıktan uzun bir süre sonra kodlara baktığınızda anlayamamanız olabilir.Ancak birden fazla kişi ile yani bir takım olarak yazılım geliştiriyorsanız kendi standartlarınızı kullanmanız halinde takım arkadaşlarınızın sizin yazdığınız kodları anlayamamasına sebebiyet verir.Bu durumda belirli standartlara uymak hem takım halinde senkronize çalışmayı hemde hızlı yazılım geliştirmeyi sağlamaktadır.Bu yazıda C# için kullanılan standartlardan bahsetmek istiyorum.

1.Değişken,metod,sınıf vs. isimlerinde kesinlikle Türkçe karakter kullanmayın

C# Türkçe karakter kullanımına izin veren bir dildir.Ancak siz siz olun Türkçe karakter kullanmaktan vazgeçin.Türkçe karakterler bazı kısımlarda farklı algılandığından sorun yaşamanız muhtemeldir.

Doğru kullanım

int buyukSayi;
string ogrenimTuru;

1 2	int buyukSayi; string ogrenimTuru;

Yanlış kullanım

int büyükSayı;
string öğrenimTürü;

1 2	int büyükSayı; string öğrenimTürü;

2.Girintiler ve Hizalama
Girinti ve hizalama sistemini alışkanlıktan öte takıntı haline getirin.Süslü parantezlerin aynı hizada olmasına dikkat edin.Kodların okunabilirliği açısından oldukça önemli bir konudur.

Doğru kullanım

public class KullaniciIslemleri
{
        //Yapıcı Metodumuz...
        public KullaniciIslemleri()
        {

        }

}

public class KullaniciIslemleri

{

//Yapıcı Metodumuz...

public KullaniciIslemleri()

{

}

Yanlış kullanım

public class KullaniciIslemleri
{
//Yapıcı Metodumuz...
public KullaniciIslemleri()
{
}

}

public class KullaniciIslemleri

{

//Yapıcı Metodumuz...

public KullaniciIslemleri()

{

}

3.Space tuşunu sık kullanın.
Kodların birbirine girmemesi açısından arada boşluklar bırakmak operatörlerin daha okunaklı olmasını sağlayacak ve kodların okunabilirliği artacaktır.

Doğru kullanım

int sayi1, sayi2, ortalama;
...
if (sayi1 == sayi2)
...
ortalama += (sayi1 + sayi2);
...

int sayi1, sayi2, ortalama;

...

if (sayi1 == sayi2)

...

ortalama += (sayi1 + sayi2);

...

Yanlış kullanım

int sayi1,sayi2,ortalama;
...
if (sayi1==sayi2)
...
ortalama+=(sayi1+sayi2);
...

int sayi1,sayi2,ortalama;

...

if (sayi1==sayi2)

...

ortalama+=(sayi1+sayi2);

...

4.Açıklama satırları
Program için belki birşey ifade etmeyebilirler ama kodların ne yaptığını açıklama satırı olarak yazmanız ilerde kodlarınıza bakarken “ya ben burda ne yapmışım” demenizin önüne geçer.Ayrıca açıklama satırlarını üşenmeden uzun ve anlaşılır yazın.Hem siz hemde kodlara bakan programcı kodun ne iş yaptığını hemen anlamalısınız.

// Satış fiyatı hesaplaması 
//
// Fonksiyon birim fiyatı ve KDV oranı olarak gönderilen
// bilgilerin satış fiyatını geri döndürür.
//
// Örnek Kullanım
// double SatisFiyati = SatisHesapla(1000,18)
//
// Donus Değeri --> 1018.0 (double)
//
private double SatisHesapla(int birimFiyati, int kdvOrani)
{
        return birimFiyati + (birimFiyati * kdvOrani) / 100;
}

// Satış fiyatı hesaplaması

// Fonksiyon birim fiyatı ve KDV oranı olarak gönderilen

// bilgilerin satış fiyatını geri döndürür.

// Örnek Kullanım

// double SatisFiyati = SatisHesapla(1000,18)

// Donus Değeri --> 1018.0 (double)

private double SatisHesapla(int birimFiyati, int kdvOrani)

{

return birimFiyati + (birimFiyati * kdvOrani) / 100;

}

4.1 TODO Açıklamaları
TODO açıklamaları sonradan yapmanız gerekenler için yazılan açıklama satırlarıdır.Örneğin bir fonksiyon yazdınız ancak içerisinde başka bir fonksiyonu çağırmanız gerekiyor ve o fonksiyonu henüz yazmadınız.TODO açıklaması olarak eklemeniz unutmamanızı sağlar.Ne demişler “Söz uçar yazı kalır”.Yapmanız gerekenleri mutlaka TODO açıklaması olarak kaydedin.

public int OrnekFonksiyon()
{
        //TODO : Sonuç ekrana yazdırılması için toplamHesap() fonksiyonu yazılacak
        Console.Writeln("Hesaplama Sonucu :");
}

public int OrnekFonksiyon()

{

//TODO : Sonuç ekrana yazdırılması için toplamHesap() fonksiyonu yazılacak

Console.Writeln("Hesaplama Sonucu :");

}

5.C# diline ait kelimeleri değişken,metod,sınıf vs.isimlerinde kullanmayın

6.Kısaltmalar
Çok zorunlu olmadıkça kısaltma kullanmatakn kaçının.Kodların daha okunbilir ve anlaşılabilir olması açısından uzun isimler verin

Doğru kullanım

int kullaniciAdi;
string sifre;

1 2	int kullaniciAdi; string sifre;

Yanlış kullanım

int kadi;
string pass;

1 2	int kadi; string pass;

7.Arayüz(Interface) İsimlendirme
Interface kullanırken tanımlamanın başına “I” getirmeniz ilerde hem kullanırken hem okurken size ve kodu okuyanlara kolaylık sağlayacaktır.

Doğru kullanım

public interface ITakip
{
        public int StokTakip(int urunAdet);
}
public class Takip :ITakip
{
        public int StokTakip(int urunAdet)
        {
               this.urunAdet = urunAdet;
        }

}

public interface ITakip

{

public int StokTakip(int urunAdet);

}

public class Takip :ITakip

{

public int StokTakip(int urunAdet)

{

this.urunAdet = urunAdet;

}

Yanlış kullanım

public interface Takip
{
        public int StokTakip(int urunAdet);
}
public class Stok :Takip
{
        public int StokTakip(int urunAdet)
        {
               this.urunAdet = urunAdet;
        }

}

public interface Takip

{

public int StokTakip(int urunAdet);

}

public class Stok :Takip

{

public int StokTakip(int urunAdet)

{

this.urunAdet = urunAdet;

}

8.Pascal/Camel Casing

İşte can alıcı nokta burası.Sadece C# için değil tüm programlama dillerinde kullanılan bir standart olan Camel Case’e geldik.Peki nedir bu Camel Case ?
Değişkenin,metodun,sınıfın,arayüzün… yani tanımlayacağınız herşeyin ilk harfinin ve sonraki gelen kelimenin ilk harfinin büyük harfle başlamasıdır.Bazı kaynaklarda ilk harfi küçük sonraki harflerin büyük olduğunu yazar.Bence çok farkeden bir durum yok ben el alışkanlığından ikinciyi daha çok kullanıyorum.

Doğru kullanım

public void KisiEkle()
...
public interface IBilgiler
...
public class Kisi
...
private int vergiNumarasi
...
protected void btnGonder_Click(object sender, EventArgs e)
...

public void KisiEkle()

...

public interface IBilgiler

...

public class Kisi

...

private int vergiNumarasi

...

protected void btnGonder_Click(object sender, EventArgs e)

...

Yanlış kullanım

public void kisiekle()
...
public interface Ibilgiler
...
public class kisi
...
private int verginumarasi
...
protected void btngonder_Click(object sender, EventArgs e)
...

public void kisiekle()

...

public interface Ibilgiler

...

public class kisi

...

private int verginumarasi

...

protected void btngonder_Click(object sender, EventArgs e)

...

Şimdilik burada bırakıyorum.Bu yazının ikinci serisinde görüşmek dileğiyle.Bol kodlu günler…

1 Comment

Uğur dedi ki:

5 Nisan 2019, 11:39

Emre merhaba, camelcasing tanımın yanlış olmuş. pascalcasing, tüm kelimelerin baş harflerinin büyük olması, camelcasing ise başlangıç harfi küçük, diğer kelimelerin baş harflerinin büyük olmasıdır.
pascalcasing: KullaniciAdi
camelcasing: kullaniciAdi

iyi çalışmalar

Cevapla

Bir cevap yazın Cevabı iptal et

This site uses Akismet to reduce spam. Learn how your comment data is processed.