CSharp(C#) Kodlama Standartları
Merhabalar,
Bugünkü yazının konusu .net kod standartları.Öncelikle bu konuda üstat Martin Fowler’ın bir sözünü paylaşmak istiyorum.
Any fool can write code that a computer can understand. Good programmers write code that humans can understand.
Türkçe meali şu şekilde; herhangi bir aptal bilgisayarın anlayacağı kodu yazabilir. İyi programcılar, insanların anlayacağı kodu yazabilirler.
İnsanların anlayacağı kodu yazmak önemlidir.Genelde çalıştığım yerlerde karşılaştığım şey, projeyi yazan kişinin işten ayrılması ile birlikte çıkmaza giren anlaşılamayan kodlar oluyor.
Microsoft’un belirlediği belli standartlar vardır.Bu standartlarda amaç hem derleyicinin işini kolaylaştırmak, hemde programcıların dünyanın neresinden olurlarsa olsunlar ortak bir kod yazma standartlarının olmasını, yazdıkları kodların anlaşılmasını sağlamaktır.
Kod okunabilirliğinin artması, hem kodun anlaşılmasını hemde refactoring yapılmasını kolaylaştırır.
Class ve metot isimlerinde PascalCasing kullanın:
Lokal tanımlamalarda ve parametre isimlerinde camelCasing kullanın:
Değişkenlerin başında tipi ile alakalı gösterge kullanmayın:
Kısaltma kullanmaktan kaçının:
Özel statik değişkenler hariç, tanımlamalarda alt çizgi kullanmayın:
Predefined type name’leri (alias) kullanın:
Lokal değişkenlerde (string,int,double vb. veri tipleri hariç) “var” kullanın:
Interface tanımlamalarında ismin başında “I” kullanın:
Güzel parantezleri hizalayın(Visual Studio’da “Ctrl + K + D” kombinasyonunu kullanabilirsiniz):
Bir class’ın içinde genel değişkenler en üst kısımda tanımlanmalı.Statik değişkenler ise onlarında üstünde olmalı:
Enum tanımlarken, enum değişkeninin isminde enum kullanmayın.Ayrıca ardışık artan sayılar kullanacaksanız, sadece isimleri yazabilirsiniz:
Yorum satırı yazarken; büyük harfle başlayın, nokta ile sonlandırın, kodun sonuna değil ayrı bir satırda yorum yazın:
Nesne oluşturma işlemini basitleştirmek için “object initializer” kullanın:
Metotlar çok fazla parametre almamalıdır.Eğer metoda çok fazla veri geliyorsa, bir class tanımlanıp, parametre olarak geçilebilir:
Yazmış olduğumuz class lar çok fazla uzun olmamalı, partial class lar kullanılmalıdır.Fazla uzun class lar kod okunabilirliğini düşürmektedir.
Erişim belirleyicilerini(access modifiers) mutlaka kullanın:
Try-catch bloklarında orjinal hatayı korumak için throw anahtar kelimesini kullanın:
Bileşik koşullu ifadelerden kaçının.Koşulları yönetebilmek için parçalamayı deneyin:
IDisposable nesneleri kullanırken using ifadesi içinde kullanın:
Kodlar arasında fazlaca boşluk bırakmaktan kaçınmakla beraber, hiç boşluk bırakmadan yazmaktan da kaçının.Kodları ilgili şekilde gruplayarak(değişkenler, karar ifadeleri, dönüş değerleri vb.) aralarında boşluk bırakarak yazın:
Kaynak:
https://docs.microsoft.com/tr-tr/dotnet/csharp/programming-guide/inside-a-program/coding-conventions
Umarım herkesin anlayabileceği sağlıklı kodlar yazabiliriz.
Mutlu kodlamalar.
