C# Kodlama Standartları

23. Nisan 2015 C/C++/C#, C# 0
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

Yanlış kullanım

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

Yanlış kullanım

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

Yanlış kullanım

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.

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.

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

C# Keywords

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

Yanlış kullanım

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

Yanlış kullanım

8.Pascal/Camel Casing
Camel Case
İş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

Yanlış kullanım

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


Bir Cevap Yazın

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