Aslında kodlama standartları sadece C# ya da farklı bir programlama dili için değil, tüm yazılım geliştiricilerin tüm programlama dillerinde uygulaması gereken kurallar bütünüdür. Birçok programlama dilinde zaten hatalı yazımları düzeltme ya da kötü yazımlara rağmen çalışma özelliği vardır; ancak ünlü bir sözde de dendiği gibi "bilgisayar sizin yazdığınız kodları her türlü anlar, asıl mesele bilgisayarların değil sizden başka insanların anlayabileceği şekilde kod yazmaktır". Programlama yaparken yazdığınız kodlarda uyacağınız kurallar da zaman içerisinde doğru yazım alışkanlıkları kazandırarak size fayda sağlamış olacaktır.
- Yorum yazmak iyi bir alışkanlıktır ve kendiniz de dahil olmak üzere çok kişiye zaman kazandırır
- Değişken isimleri mantıklı ve tutarlı olmalıdır. Örneğin a ya da d1 gibi ileride kendiniz ya da bir başkası tarafından bir anlam ifade etmeyecek değişken isimleri yerine agirlik ya da hiz gibi mantıklı ve anlaşılabilir değişken isimleri tercih edilmelidir.
- Fonksiyon, metod, sınıf gibi program katmanları da yine işlevlerine göre doğru bir şekilde adlandırılmalıdır
- Doküman hazırlamak, yazılım geliştirmenin en önemli ve gerekli aşamalarından birisidir. Hem ekip çalışmalarında kurumsal hafıza tutmak adına, hem de programların kullanıcılarına yardımcı olmak amacıyla dokümantasyon hazırlamaya da gerekli zaman ayırılmalıdır
- Versiyonlama yapmak, programların sürümleri arasındaki iyileştirmeler, gelişmeler ve hata düzeltmeleri takip edebilmeyi ve ileriye dönük olarak da plan yapabilmeyi mümkün kılar. Versiyonlarınızı son ya da enson gibi isimlendirmeyin ve sürekli üzerine kaydetmeyin. Bunun yerine git sistemleri kullanın, versiyonlayın ve versiyonlardaki özellikleri log'layın.
- Kervanın yolda dizilmesi programlar için geçerli değildir, eğer bu şekilde bir debug süreci düşünüyorsanız çok zararlı çıkabilirsiniz. Testler için gerekli zamanı ve eforu mutlaka ayırın.
Gelelim C# özelinde tavsiye edilen yazım standartlarına.
- Sınıf (class) isimleri büyük harfle başlamalı ve her yeni kelime, arada boşluk bırakmadan yine büyük harfle başlatılmalı (Pascal Case). Örneğin class adı olarak
kullaniciaktiviteleri -> yanlış
kullaniciAktiviteleri -> yanlış
KullaniciAktiviteleri -> doğru
- Metod (yöntem) isimleri için de yine Pascal Case ile yazılmalıdır.
- Lokal değişkenler için ilk harf küçük, sonraki her bir kelimenin ilk harfi büyük olacak şekilde yazılmalıdır (Camel Case)
kullaniciadi -> yanlış
KullaniciAdi -> yanlış
kullaniciAdi -> doğru
Daha önce paylaştığım yazılardan bazıları için;
bkz: (C# ve Asp.NET) Sayıların Kare Kökünü Hesaplamak
bkz: (C# ve Asp.NET) Yazıları büyük harf ile yazdırmak
bkz: (C# ve Asp.NET) Yazıları küçük harf ile yazdırmak
bkz: (C# ve Asp.NET) String'in sadece ilk harfini büyük harf ile yazdırmak
bkz: VS Code HTML Kod Şablonu Ekleme Klavye Kısayolu
bkz: Hashing Nedir?