Visual Basic.NET Kodlama Standartları. Versiyon Geçmişi. Tarih Ver Açıklama Yazar(lar) Gözden Geçiren(ler) Belge oluşturuldu - -

Transkript

1

2 Visual Basic.NET Kodlama Standartları Versiyon Geçmişi Tarih Ver Açıklama Yazar(lar) Gözden Geçiren(ler) Belge oluşturuldu - - ii

3 v1.0 Künye Proje Koordinatörü Kadir Çamoğlu Editör Volkan Atasever Kapak Tasarımı Hakan Çamoğlu Volkan ATASEVER Merve CEYLAN Kadir ÇAMOĞLU Burhan ÇETİNKAYA Bahtiyar DİLEK Yazarlar İrfan MEVSİM Can YAPAN Hakan YAVUZ Yücel YILDIRIM Bahri Altan Atagün Sarıbayraktar Soykan Özçelik Mesut Güneş Gözden Geçirenler Kemal İkizoğlu Erman Demirer Haluk Aksoy İbrahim Atay iii

4

5 Đçindekiler Önsöz... 4 Amaç... 5 Kapsam... 5 Kullanım Şartları... 5 Kullanım Önerisi... 5 Önemli Açıklama... 5 Geri Bildirim Dosya Organizasyonu Klasör Yapısı Kaynak Kod Dosyaları Biçimlendirme Sınıf Yapısı Girintileme ve Kapsamı Belirleme Boşluklar Açıklamalar Blok Açıklamalar Tek Satırlık Açıklamalar Satır İçi Açıklamalar Dokümantasyon Amaçlı Açıklamalar TODO : Açıklamalar Đsimlendirme Kuralları Büyük/Küçük Harf Kullanımı Pascal/Camel Casing Visual Basic.NET Diline Özel Ayrılmış Kelimeler Büyük/Küçük Harf Hassasiyeti Kısaltmalar Kelime Seçimi İsim Alanı İsimlendirme Sınıf İsimlendirme Ara Birim İsimlendirme Öznitelik İsimlendirme Numaralandırma İsimlendirme... 21

6 Visual Basic.NET Kodlama Standartları 4.12 Sabit ve Salt Okunur Alan İsimlendirme Statik Alan İsimlendirme Parametre İsimlendirme Metot İsimlendirme Özellik İsimlendirme Olay İsimlendirme Değişken İsimlendirme ve İlk Değer Atama Kontrol İsimlendirme Deyimler Basit Deyimler Return Deyimleri If, if-else, if else-if else Deyimleri Select Deyimleri For / Foreach Deyimleri While/do-while Deyimleri İstisnai Durum Yönetimi

7 v1.0 Terimler Terim Türkçe Açıklama Namespace İsim alanı Class Sınıf Interface Ara birim Attribute Öz nitelik Enumeration Numaralandırma Property Özellik Event Olay Constant Sabit Readonly Salt okunur Pascal Casing - İsimler BÜYÜK harfle başlar. İsmi oluşturan ifade birden fazla kelimeden oluşuyorsa, kelimelerin ilk harfleri BÜYÜK harflerle yazılır. (OgrenciKaydet, UcretHesapla, RaporYazdir) Camel Casing - İsimler küçük harfle başlar. İsmi oluşturan ifade birden fazla kelimeden oluşuyorsa, isimdeki ilk kelime küçük harfle başlar. Sonraki kelimeler BÜYÜK harfle başlar. (yeniogrencikaydet, ucrethesapla, raporyazdir) 3

8 Visual Basic.NET Kodlama Standartları Önsöz Özlü bir söz vardı yıllar önce okuduğum: Bilgisayarların okuyacağı kodu yazmak kolay, önemli olan insanların okuyabileceği kodu yazmak. diyordu. İlk başta çok havalı gelen bu deyişi sonrasında biraz düşünmek istedim. Yazdığımız kodu bilgisayarın okuması yeterli değil mi? Zaten bilgisayar çalıştırmıyor mu onu? Tamam işte, bilgisayar çalıştırıyorsa her şey yolunda demektir değil mi? Bazen. Altı ay önce yazdığınız bir kodu tekrar açıp değiştirmek ihtiyacı hissettiğinizde kodlara bakıp hiç Yahu ne yapmışım ben? İyi kod yazmışım valla dediğiniz oldu mu? Eminim olmuştur. Sonuçta hepimiz geçtik bu yollardan. İster eski projelerinizdeki kodları hatırlayamayan ve kodu okuyamayan siz olsun, ister bir projede beraber çalıştığınız arkadaşlarınız olsun tüm bu senaryolar eninde sonunda yazdığınız kodların bir insan tarafından da okunması gerekeceğine dair ipuçları veriyor. Ekranınızdaki bu PDF veya belki de çıktısını aldığınız bu doküman size bu yolda yardımcı olma amacı taşıyor. Tabi ki siz de kendi tekniklerinizi ve kod yazım kurallarınızı oluşturabilir ve uygulayabilirsiniz fakat bir kısım genel geçer, artık gelenekselleşmiş kurallara uymanın da farklı faydaları olacaktır. Tavsiyem, eğer tek başınıza kod yazıyorsanız en azından ileriye dönük hem kişisel hem de proje bazında bir yatırım olarak bu kurallara uymaya çalışın. Şaka değil, böylece dünya hepimiz için (yazılım geliştiriciler) daha güzel bir yer olabilir. Eğer bir ekiple kod yazıyorsanız önce şirketinizde böyle bir doküman olup olmadığını öğrenin. Varsa ne kadar uygulandığını araştırın, gerekiyorsa revizyonlar önerin. Böyle bir doküman yoksa şirketinizde hemen bu dokümanı basıp herkese dağıtın. Yazılan bir kodun insanlar tarafından okunabilirliğinin uzun vadede kurumlara ciddi karlar getireceğini de yöneticinizle paylaşmanızda fayda olacaktır. Artık top sizde! Bir sonraki adımı atıp insan dostu kodlar yazmak elinizde. Benim son olarak yapmak gereken bir şey daha var; bu dokümanın oluşturulmasında, hazırlanmasında ve belki de size ulaşmasında birçok dostun, kardeşimizin emeği var. Hepsine daha iyi bir yazılım dünyasına katkıları için sonsuz teşekkür ediyorum. Emeğinize sağlık! Daron Yöndem Microsoft Regional Director INETA MEA Vice President 4

9 v1.0 Giriş Amaç Kapsam Bu dokümanı geliştirmekteki amacımız, VB.NET programlama diliyle geliştirilecek projelerde kullanılmak üzere, kodlama standartları için fikir verecek bir örnek oluşturmaktır. Bu doküman, VB.NET Kodlama Standartları belgesinin ilk sürümüdür. Bu nedenle isimlendirme, biçimlendirme ve temel kodlama yapıları gibi en temel konulara değinilmiştir. Kullanım Şartları Bu doküman bir grup çalışmasının ürünüdür. Belgenin sahipleri teknik olarak künyede yazılı olan (gözden geçirenler hariç) isimlerdir. Belgeyi, kaynak belirtmek koşuluyla tamamen ya da kısmen kullanabilirsiniz. Kopyalayabilir, çoğaltabilir ve dağıtabilirsiniz. Kullanım Önerisi Bu belgeyi geliştireceğiniz projelerde olduğu gibi kullanmanız mümkün olabileceği gibi, kendi standartlarınızı oluşturmak için temel almak üzere de kullanabilirsiniz. Özellikle daha önceden edindiğiniz yazılım geliştirme alışkanlıklarınız varsa, bunları dokümandakilerle karşılaştırarak uygun gördüğünüzü tercih edebilirsiniz. Önemli Açıklama Geri Bildirim Bu dokümanda belirtilen hiçbir kodlama standardı, ulusal ya da uluslararası genel bir standardı ifade etmez. Bu dokümanda açıklanan standartlar, içeriği geliştirenlerin ve proje koordinatörünün tecrübeleriyle oluşturdukları, kendi projelerinde uyguladıkları kodlama yaklaşımlarıdır. Bu dokümanda yazılanları VB.NET programlama dilinin, ilişkili teknolojilerin ya da yazılım mühendisliğinin temel kuralları olarak görmeyin. Dokümanı geliştirenlerin hiçbir şekilde en doğru ve en iyi yazılım kodlama standardını oluşturmak gibi bir iddiası yoktur. Buradaki amaç bir öneri ve/veya örnek oluşturmaktır. Bu proje gönüllük esasına dayalı olarak, geniş bir katılımcı kitlesiyle hazırlanmıştır. Bu dokümanın olgunlaşması ve daha kaliteli hale gelmesi için, dokümanı inceleyen, kullanan herkesin geri bildirimi bizim için çok değerli olacaktır. Lütfen dokümanla ilgili hataları, önerilerinizi ve her türlü geri bildiriminizi aşağıdaki web ve eposta adresleri üzerinden bizimle paylaşın. Eposta:

10 Visual Basic.NET Kodlama Standartları 1. Dosya Organizasyonu 1.1 Klasör Yapısı Kullanım amaçlarına yönelik olarak, kaynak kodlarını bir arada tutacak şekilde klasör yapısı oluşturun. Klasörün amacına yönelik isimlendirme yapın. Böylelikle hangi dosyanın nerede olduğu kolayca bulunabilir. 6

11 v Kaynak Kod Dosyaları Kaynak kod dosyalarını, klasör yapısına uygun olarak amaçlarına uygun yerde oluşturun. 7

12 Visual Basic.NET Kodlama Standartları 2. Biçimlendirme 2.1 Sınıf Yapısı Sınıfların isimlendirilmesinde Pascal Casing kullanın. İsimlendirmede, ismin sonuna Class veya Sınıf kelimesi eklemeyin. Sınıf Erişim belirteçlerini (private, public, internal) mutlaka belirtin. Her sınıf için mutlaka en az bir yapıcı metot (Constructor) oluşturun. Parçalı (partial) sınıflar kullandığınızda, her bir parça içerisinde, diğer parçaların yerini belirtin. Yapıcı metodumuzun içinde parametrelerinizi eşleştirirken mutlaka Me ekini kullanın. Public Class HastaIlac '<summary>hastanın kullandığı ilaç Bilgisi</summary> Public Sub New(ByVal ilacbarkod As String, _ ByVal ilacadi As String) End Class KÖTÜ Public Class HastaIslemleriSinifi Public Sub New() End Class 8

13 v1.0 Sınıfları oluştururken girintileri doğru şekilde uygulamaya dikkat edin. Public Class HastaIlac Private ilacadi As String Public Property IlacAd() As String Get Return IlacAdi End Get Set(ByVal value As String) ilacadi = value End Set End Property Private ilacbarkod As String Public Property IlacBarkodu() As String Get Return ilacbarkod End Get Set(ByVal value As String) ilacbarkod = value End Set End Property '<summary>hastanın kullandığı ilaç Bilgisi</summary> Public Sub New(ByVal ilacbarkod As String, ByVal ilacadi As String) Me.IlacAd = ilacadi Me.IlacBarkodu = IlacBarkodu End Class Public Class HastaIlac Private ilacadi As String Public Property IlacAd() As String Get Return ilacadi End Get Set(ByVal value As String) ilacadi = value End Set End Property Private ilacbarkod As String Public Property IlacBarkodu() As String Get Return ilacbarkod End Get Set(ByVal value As String) ilacbarkod = value End Set End Property '<summary>hastanın kullandığı ilaç Bilgisi</summary> Public Sub New(ByVal ilacbarkod As String, ByVal ilacadi As String) IlacAd = ilacadi IlacBarkodu = IlacBarkodu End Class 9

14 Visual Basic.NET Kodlama Standartları 2.2 Girintileme ve Kapsamı Belirleme Girinti kullanırken dikkatli olun. Girinti (sekme/tab) ve boşlukları uygun şekilde kullanın. Kod ya da açıklama yazarken boşluk kullanmayın. İsim alanı, sınıf, metot, koşul, döngü, istisnai durum yönetimi bloklarının her biri için ayrıca girintileme yapın. Public Class HastaIslemleri 'Hasta Kayıt işlemleri Public Sub New() 'Yapıcı Metodumuz... 'Hasta kayıt edilir Public Sub HastaKayit(ByVal tckimlikno As String) End Class Public Class HastaIslemleri 'Hasta Kayıt işlemleri Public Sub New() 'Yapıcı Metodumuz... Public Sub HastaKayit(ByVal tckimlikno As String) End Class End Class 2.3 Boşluklar Visual Studio birçok durumda boşluk durumlarını sizin için hallediyor... Ancak fonksiyonlar ve sublar arasındaki boşlukları sizin düzenlemeniz gerekiyor. Private Function YasHesapla(_ ByVal dogumgunu As DateTime) As Integer '... End Function Private Function YasHesapla(_ ByVal dogumgunu As DateTime, _ ByVal hesaplanacaktarih As DateTime) As Integer '... End Function 10

15 v1.0 Private Function YasHesapla(_ ByVal dogumgunu As DateTime) As Integer '... End Function Private Function YasHesapla(_ ByVal dogumgunu As DateTime, _ ByVal hesaplanacaktarih As DateTime) As Integer '... End Function 3. Açıklamalar 3.1 Blok Açıklamalar Blok açıklamalarını, fonksiyon, modül veya proje gibi kodların başında, daha sonraki kullanımlarda gerekli olabilecek açıklamaları girmek için kullanın. Açıklamaları, çok detaya inmeden genel hatlarıyla kod bloğunun kullanımını ve gerekli olabilecek diğer bilgileri kullanarak oluşturun. ' Satış fiyatı hesaplaması Đrfan Mevsim ' ' Fonksiyon birim fiyatı ve KDV orani olarak gönderilen ' bilgilerin satış fiyatını geri döndürür. ' ' Örnek Kullanım ' Dim SatisFiyati as Double = SatisHesapla(1000,18) ' ' Dönüş Değeri --> (double) ' Private Function SatisHesapla _ (ByVal BirimFiyat As Integer, _ ByVal KdvOrani As Integer) _ As Double Return BirimFiyat + KdvOrani% End Function ' Satış fiyatı hesaplaması (yetersiz açıklama) Private Function SatisHesapla _ (ByVal BirimFiyat As Integer, _ ByVal KdvOrani As Integer) _ As Double Return BirimFiyat + KdvOrani% End Function 11

16 Visual Basic.NET Kodlama Standartları Private Function SatisHesapla _ (ByVal BirimFiyat As Integer, _ ByVal KdvOrani As Integer) _ As Double ' Dönüş Değeri --> (yanlış ve yetersiz açıklama) Return BirimFiyat + KdvOrani% End Function 3.2 Tek Satırlık Açıklamalar Tek satırlık açıklamaları alt kısımdaki kod bloğunu açıklar nitelikte, belirli işlemlerin gerçekleştiği kod bloklarının başına yazın. ' Satış fiyatı hesaplaması Dim BirimFiyat As Integer = 1000 Dim KdvOrani As Integer = 18 Dim Miktar As Integer = 3 Dim SatisFiyati As Double = (Miktar * BirimFiyat) + KdvOrani% ' Birim fiyat tanımlaması Dim BirimFiyat As Integer = 1000 Dim KdvOrani As Integer = 18 Dim Miktar As Integer = 3 Dim SatisFiyati As Double = (Miktar * BirimFiyat) + KdvOrani% 3.3 Satır İçi Açıklamalar Satır içi açıklamaları, sadece bulunduğu satırdaki ifadeyi açıklamak ve o satıra ait olan bilgileri girmek için kullanın. Dim KullaniciAdi As String = "Ahmet" ' Kullanıcının Adı Dim KullaniciSoyadi As String = "Kozdağ" ' Kullanıcının Soyadı Dim KullaniciSicil As String = "D201056" ' Kullanıcının Sicil No Dim KullaniciAdi As String = "Ahmet" ' Kullanıcı Bilgileri Dim KullaniciSoyadi As String = "Kozdağ" Dim KullaniciSicil As String = "D201056" 12

17 v1.0 Dim KullaniciAdi As String = "Ahmet" ' Kullanıcı Bilgileri Dim KullaniciSoyadi As String = "Kozdağ" ' Kullanıcı Bilgileri Dim KullaniciSicil As String = "D201056" ' Kullanıcı Bilgileri 3.4 Dokümantasyon Amaçlı Açıklamalar Dokümantasyon amaçlı açıklamaları; yazdığınız herhangi bir sınıf ya da fonksiyonun açıklamasını yapmak amacıyla kullanın. Açıklama yaptığınız metoda uygun olarak özet (summary), parametre ve dönüş değerleri için açıklamalar yazın. '/ <summary> '/ Basit bir Fonksiyon.</summary> '/ <param name="yazi"> '/ Gelen yaziyi txtmetin.text 'e eşitler</param> Public Sub MetinYaz(ByVal yazi As String) txtmetin.text = yazi 3.5 TODO : Açıklamalar TODO: açıklamalarını projenin herhangi bir anında aklınıza gelen ama daha sonra yapılması gereken işlemler için kullanın. Böylece projenin hangi aşamasında hangi değişikleri yapmanız gerektiğini Build etmeden önce TODO: kelimesini projenizde arayarak rahatlıkla hatırlayabilirsiniz. ' TODO: Hesaplamadan önce KDV oranlarının güncelliğini kontrolet Dim SatisFiyati As Double = (Miktar * BirimFiyat) + KdvOrani% ' TODO: Satış fiyatı hesaplanması Dim SatisFiyati As Double = (Miktar * BirimFiyat) + KdvOrani% 13

18 Visual Basic.NET Kodlama Standartları 4. Đsimlendirme Kuralları 4.1 Büyük/Küçük Harf Kullanımı Özellik ve değişken gibi öğeleri isimlendirirken kelimelerin ilk harflerini küçük diğer harflerini büyük kullanın. Sınıf ve metotlarda ise ilk harfleri büyük kullanın. Dim toplamayap As Integer Dim cikarmayap As String Public Property ToplamaIslemi(ByVal ilksayi As Integer, ByVal ikincisayi As Integer) As Integer Class Kisiler Dim TOPLAMAYAP As Integer Dim CIKARMAyap As String Public Property toplamaislemi(byval ilksayi As Integer, ByVal ikincisayi As Integer) As Integer Class KISILER 4.2 Pascal/Camel Casing İsimlendirme yaparken Pascal/Camel isimlendirmeyi doğru yapmak için aşağıdaki tabloyu kullanın. Metotlarda, alanlarda (field) ve özelliklerde (properties) public, private, internal da olsa Pascal Casing kullanın. Proje dosyası Pascal Casing HastaTakibi.vbproj Kaynak dosyası Pascal Casing HTLogo.jpg Sınıf (class) Pascal Casing Kisi Yapı (struct) Pascal Casing KisiListeBilgisi Arabirim (interface) Pascal Casing IKisiselBilgiler Metot Pascal Casing KisiEkle Özellik (Property) Pascal Casing Adi, Soyadi Alan (public field) Pascal Casing TCKimlikNo Alan (diğer Field) Camel Casing dogumtarihi Numaralandırma (Enum) Pascal Casing KayitDurumu Delegate (public) Pascal Casing KayitSilindi Delegate (diğer) Camel Casing kayitisleniyor Değişken Camel Casing verginumarasi Parametre Camel Casing ad, soyad, yas Olay (event) Camel_Casing btnkaydet_click 14

19 v Visual Basic.NET Diline Özel Ayrılmış Kelimeler Aşağıdaki kelimeler Visual Basic.NET programlama diline özeldir. Bu kelimeleri farklı büyük/küçük harf kombinasyonlarında da olsa kullanmayın. AddHandler DirectCast Module Shadows AddressOf Do MustInherit Shared Alias Double MustOverride Short And Each MyBase Single AndAlso Else MyClass Static As ElseIf Namespace Step Boolean End Narrowing Stop ByRef EndIf New String Byte Enum Next Structure ByVal Erase Not Sub Call Error Nothing SyncLock Case Event NotInheritable Then Catch Exit NotOverridable Throw CBool FALSE Object To CByte Finally Of TRUE CChar For On Try CDate Friend Operator TryCast CDec Function Option TypeOf CDbl Get Optional Variant Char GetType Or Wend CInt Global OrElse UInteger Class GoSub Overloads ULong CLng GoTo Overridable UShort CObj Handles Overrides Using Const If ParamArray When Continue Implements Partial While CSByte Imports Private Widening CShort In Property With CSng Inherits Protected WithEvents CStr Integer Public WriteOnly CType Interface RaiseEvent Xor CUInt Is ReadOnly #Const 15

20 Visual Basic.NET Kodlama Standartları CULng IsNot ReDim #Else CUShort Let REM #ElseIf Date Lib RemoveHandler #End Decimal Like Resume #If Declare Long Return Default Loop SByte Delegate Me Select Dim Mod Set 4.4 Büyük/Küçük Harf Hassasiyeti Türkçe karakterler farklı algılandığından kodlama içerisinde Türkçe karakterler kullanmayın. Küçük i ve bu karakteri büyük yazarken I kullanın. Ç yerine c, ş yerine s, ğ yerine g, ü yerine u, ö yerine o tercih edin. Dim kacisveilk As Integer Dim ogrenmeveegitim As String Dim KaçışveĐlk As Integer Dim ÖğrenmeVeEğitim As String Fonksiyonlarda parametre kullanırken, verilen tek karakterli isimleri büyük veya küçük versiyonlarını yazarak kullanmayın. Public Property ToplamaIslemi(ByVal istenensayi As Integer, ByVal verilensayi As Integer) As Integer Public Property ToplamaIslemi(ByVal b As Integer, ByVal B As Integer) As Integer Aynı isimli fakat harflerinin büyüklüğü küçüklüğü farklı değişkenler tanımlamayın. Dim denemesayisi As Integer Dim eldesayisi As Integer Dim deneme As Integer Dim DENEME As Integer 16

21 v1.0 Farklı büyük/küçük harf hassasiyetlerinde, aynı isimli metotlar yazmayın. Private Sub ToplamaHesabi() Private Sub CikarmaHesabi() Private Sub hesapla() Private Sub Hesapla() 4.5 Kısaltmalar Sınıf, özellik, metot, değişken gibi öğelere isim verirken çok zorunlu olmadıkça kısaltma kullanmayın. Dim kullaniciadi As Integer Dim yetkilimi As Boolean Private Sub KullaniciKaydet() Dim kuladi As Integer Dim ytklmi As Boolean Private Sub KullKyd() Eğer aynı isme sahip aynı türden iki veya daha fazla öğe kullanılacaksa bunları numaralandırmayı tercih edin. Dim ogrenci1 As Integer Dim ogrenci2 As Integer Dim ogrenciilk As Integer Dim ogrenciiki As Integer 17

22 Visual Basic.NET Kodlama Standartları 4.6 Kelime Seçimi Kolay okunabilir, tanımlayıcı isimleri seçin. Private _urunadi As String Public Property UrunAdi() As String Get Return _urunadi End Get Set(ByVal value As String) _urunadi = value End Set End Property Private _adiurun As Integer Public Property AdiUrun() As Integer Get Return _adiurun End Get Set(ByVal value As Integer) _adiurun = value End Set End Property Tanımlayıcı isimlerinizi kısa tutmak için onları anlamsızlaştırmayın. Private _kullaniciadi As String Public Property KullaniciAdi() As String Get Return _kullaniciadi End Get Set(ByVal value As String) _kullaniciadi = value End Set End Property Private _kadi As String Public Property kadi() As String Get Return _kadi End Get Set(ByVal value As String) _kadi = value End Set End Property 18

23 v1.0 Tanımlayıcılarınızı isimlendirirken hiçbir zaman tire -, alttan tire _ veya alfanumerik olmayan karakterler!@#$%^&*() kullanmayın. Private _dogumtarih As Date Public Property DogumTarihi() As Date Get Return _dogumtarih End Get Set(ByVal value As Date) _dogumtarih = value End Set End Property Private _dogumtarih As DateTime Public Property Dogum-Tarihi() As DateTime Get Return _dogumtarih End Get Set(ByVal value As DateTime) _dogumtarih = value End Set End Property Tanımlayıcılarınızı hiçbir zaman Macar Notasyonu - Hungarian Notation- ile isimlendirmeyin. Dim u32identifier As Integer Dim bbusy As Boolean Dim chinitial As Char Dim dbpi As Double Dim rgstudents As String() = New String(4) {} Dim hwndform As Form1 4.7 İsim Alanı İsimlendirme İsim alanı adlandırırken, Pascal Casing tipi isimlendirme kullanın. Büyük harfle başlayıp her bir kelimenin ilk harfini büyük harf kullanarak isim verin. Kelimeler arasında _ veya - benzeri ayraçlar kullanmayın. İsim alanı adlandırırken, proje/assembly adı ile aynı adı kullanın. Kullandığınız dizinlerin adlarını, isim alanı adlarında da kullanın. KodlamaStandartlari.vbproj namespace KodlamaStandartlari KodlamaStandartlari.Models.dll namespace KodlamaStandartlari.Models KodlamaStandartlari.vbproj projesinde Models dizini namespace KodlamaStandartlari.Models 19

24 Visual Basic.NET Kodlama Standartları KodlamaStandartlari.vbproj namespace Kodlama KodlamaStandartlari.Models.dll namespace KodlamaStandartlari.Modeller KodlamaStandartlari.vbproj projesinde Models dizini namespace KodlamaStandartlari.Modeller 4.8 Sınıf İsimlendirme Sınıflara ad verirken, Pascal tipi isimlendirme kullanın. Büyük harfle başlayıp her bir kelimenin ilk harfini büyük harf kullanarak isim verin. Kelimeler arasında _ veya - benzeri ayraçlar kullanmayın. Sınıflara ad verirken, isim veya isim öbeği kullanın. Sınıflara adlarında, Sınıf, Class veya C gibi ifadeler kullanmayın. Public Class Araba Internal Class Ucurtma Private Class UcakMotoru Public Class Yap Internal Class ClassUcurtma Internal Class CucurtmaSinifi Private Class UcakmotoruClass 4.9 Ara Birim İsimlendirme Ara birimlerinizi uygulayacağınız sınıfların isimleriyle birlikte başlarına I harfi getirerek yazın. Ara biriminizi isimlendirirken her iki kelimenin ilk harfleri büyük olacak şekilde isimlendirin.(pascalcasing) Public Class Takip Implements ITakip Public Interface ITakip Sub StokTakip(ByVal urunadet As Integer) End Interface Public Sub StokTakip1(ByVal urunadet As Integer) Implements ITakip.StokTakip Me.urunAdet = urunadet.tostring() End Class 20

25 v1.0 Public Class Takip Implements StokInterface Public Interface StokInterface Sub StokTakip(ByVal urunadet As Integer) End Interface Public Sub StokTakip1(ByVal urunadet As Integer) Implements ITakip.StokTakip Me.urunAdet = urunadet.tostring() End Class 4.10 Öznitelik İsimlendirme Kendi geliştirdiğiniz öznitelik sınıflarınızı isimlendirirken, sınıf isminizin sonunda Attribute kelimesini getirin. <AttributeUsage(AttributeTargets.Class)> _ Public Class AttributeTakip End Class <AttributeUsage(AttributeTargets.Class)> _ Public Class Takip End Class 4.11 Numaralandırma İsimlendirme Numaralandırmalarınızı isimlendirirken Pascal Casing isimlendirme kuralını dikkate alın. Numaralandırma isimlerinizin sonuna enum yazmayın. Numaralandırmalarınız için tekil isimler seçin. Enum OnemDerecesi Yuksek = 3 Orta = 2 Dusuk = 1 End Enum Enum OnemDereceleriEnum Yuksek = 3 Orta = 2 Dusuk = 1 End Enum 21

26 Visual Basic.NET Kodlama Standartları 4.12 Sabit ve Salt Okunur Alan İsimlendirme Sabit ve Salt Okunur alanlar isimlendirilirken; isim, isim tamlaması ve (çok uzunsa) anlamlı kısaltmaları; her kelimenin ilk harfi büyük olacak şekilde kullanın. (PascalCasing) Public Const AySayisi As Integer = 12 Public Const HaftaSayisi As Integer = 52 Public ReadOnly GunSayisi As Integer = 365 Public Const Ay_Sayisi As Integer = 12 Public Const haftasayisi As Integer = 52 Public ReadOnly _Gun_Sayisi As Integer = Statik Alan İsimlendirme Statik alanlar isimlendirilirken; isim, isim tamlaması ve (çok uzunsa) anlamlı kısaltmaları; her kelimenin ilk harfi büyük olacak şekilde kullanın. (PascalCasing) Public Shared Fiyat As Integer Public Shared ToplamSaat As Integer Public Shared fyt As Integer Public Shared fiyat As Integer Public Shared toplam_saat As Integer 4.14 Parametre İsimlendirme Parametre isimlendirilirken; içeriğine göre anlamlı olarak, isim, isim tamlaması ve (çok uzunsa) anlamlı kısaltmaları; birinci kelimenin ilk harfi küçük bunu takip eden kelimelerin baş harfleri büyük olacak şekilde kullanın. (Camel Casing) Private Sub KullaniciKaydet(kullaniciAdi As String, _ parola As String) Private Sub KullaniciKaydet(kul_adi As String, _ prl As String) 22

27 v Metot İsimlendirme Metotlarınızı isimlendirirken Pascal isimlendirme kuralını kullanın.(pascal Casing) Metot parametreleriniz için Camel isimlendirme kuralını kullanın.(camel Casing) Metotlarınızı fiille veya fiil cümleleriyle isimlendirin. Public Function Topla(ByVal birincisayi As Integer, ByVal ikincisayi As Integer) As Integer Return birincisayi + ikincisayi End Function Public Function Toplama (ByVal BirinciSayi As Integer, ByVal IkinciSayi As Integer) As Integer Return BirinciSayi + IkinciSayi End Function 4.16 Özellik İsimlendirme Özelliklerinizi isimlendirirken Pascal isimlendirme kuralını kullanın.(pascal Casing) Özelliklerinizi isim ve isim tamlamalarıyla isimlendirin. Özelliklerinizin tiplerine uygun isimlendirme yapın. Özelliklerinizi isimlendirirken başlarına Get veya Set getirmekten sakının. Public IsimSoyisim As Integer Public OdemeTarihi As Date 'OnemDerecesi Enum bir tipe sahiptir. Public OnemDerecesi As OnemDerecesi Public Getisim As String Public OdemeTarihiniAl As Date Public SetOnemDerecesi As OnemDerecesi 4.17 Olay İsimlendirme Olay(Event) işleyici isimlendirmede on ifadesini kullanmayın. Event EventHandler As ciftikla Event EventHandler As ONciftikla 23

28 Visual Basic.NET Kodlama Standartları Tek bir event isimlendiriyorsanız geçmiş zamanda fiiller kullanın. Event EventHandler As mesajyollandi Event EventHandler As cifttiklandi Event EventHandler As mesajyolla Event EventHandler As cifttikla 4.18 Değişken İsimlendirme ve İlk Değer Atama Vereceğimiz isimler Türkçe olmalıdır. Tanımlama yaparken kullanacağımız isimlerde,kısaltma yapılacaksa da anlamlarını kaybetmemelerine dikkat edilmelidir. Class ResimBoyutlandirici Dim resimyolu As String = "c:" Dim cozunurluk As String = "1024x768" End Class Class WindowsFormsApplication1 Dim resimyolu As String = "c:" Dim cozunurluk As String = "1024x768" End Class 4.19 Kontrol İsimlendirme Kontrol İsimlendirirken, kontrollerin önüne, ilgili kontrolü belirtecek bir kısaltma kullanın. Private Sub btnbaslat_click(byval sender As System.Object, ByVal e As System.EventArgs) Private Sub lblaciklama_click(byval sender As _ System.Object, ByVal e As System.EventArgs) Private Sub Baslat_Click(ByVal sender As System.Object, ByVal e As System.EventArgs) Private Sub Aciklama_Click(ByVal sender As System.Object, ByVal e As System.EventArgs) 24

29 v Kontrol isimlendirme için aşağıdaki tabloyu kullanın. Kontrol Kısaltması Checkbox chk RadioButton rdb Label lbl Textbox txt DataGrid dtg Button btn ImageButton İmb Image img PlaceHolder phd Table tbl CheckBoxList cbl RadioButtonList rbl Radio(Option)Button opt Hyperlink lnk DropDownList ddl ListBox lst DataList dtl Repeater rpt Panel pnl Validators val ComboBox cmb DropDownList ddl GridView gvw hscrollbar hsc vscrollbar vsc Picture pic Container ctr DataColumn dcol DataGridDateTimePickerColumn dgdtpc DataGridTableStyle dgts DataGridTextBoxColumn dgtbc DataReader drd DataRow drw DataSet dset DataTable dtable GroupBox gbx HashTable htbl ImageList iml Integer int Literal ltr MarshallByRefObject rmt Mainmenu mm MenuItem mi MD5 md5 MDI-Frame frame MDI-Sheet sheet NumericUpDown nud PictureBox pbx RadioButton rbtn StatusBar stb TabControl tabctrl TabPage tabpage ToolBar tbr ToolBarButton tbb

30 Visual Basic.NET Kodlama Standartları 5. Deyimler 5.1 Basit Deyimler Basit deyimleri yazarken her bir satıra sadece bir deyim yazın. Deyimleri açık ve okunur şekilde kodlayın. Dim sayi1 As Integer = 5 Dim sayi2 As Integer = 5 Dim toplam As Integer = sayi1 + sayi2 Dim sayi2 As Integer = 5,sayi2 As Integer = 5 Dim toplam As Integer = sayi1 + sayi2 5.2 Return Deyimleri Fonksiyonlardan değer döndürürken her bir koşul için ayrı ayrı değer döndürmeyin. Koşulları kontrol ettikten sonra fonksiyonunun sonunda tek bir return deyimi kullanın. Public Function MusteriAdiGetir() As String 'MusteriAdi Getir Fonksiyonu Tanımlama Dim musteriad As String = "" 'musteriad string değişkeni tanımlama ve atama Dim musterino As Integer = 1 'musterino eğişkeni tanımlama ve atama If (musterino = 1) Then musteriad = "Yücel Yıldırım" Else musteriad = "Müşteri Bulunamadı" End If Return (musteriad) End Function Public Function MusteriAdiGetir() As String 'MusteriAdi Getir Fonksiyonu Tanımlama Dim musteriad As String = "" 'musteriad string değişkeni tanımlama ve atama Dim musterino As Integer = 1 'musterino değişkeni tanımlama ve atama If (musterino = 1) Then Return "Yücel Yıldırım" Else Return "Müşteri Bulunamadı" End If End Function 26

31 v If, if-else, if else-if else Deyimleri Hemen hemen her programlama dilinde olan deyimlerdir. Bir şart belirtilerek programın ona göre davranmasını sağlar. Bu yüzden bu deyimlerin standartlara göre yazılması oldukça önemlidir. Öncelikle genel olarak if deyimindeki yanlışlıkları ve olması gerekenleri gösterelim. Koşul deyiminiz tek satırlık ise end if kullanmayın. iyi: If ("1" = "1") Then MessageBox.Show("1 eşittir 1") If ("1"="1") Then MessageBox.Show("1 eşittir 1") End If Karmaşık koşulları if bloğu içine yazmayın. Bu tip koşulları blok öncesinde kontrol ederek sonucu değişkenlere yükleyerek if koşuluna yazın. enyukseknotmu = (notum > enyukseknot) oncekienyukseknotmu = (notum = enyukseknot) gecerlinotmu = (notum < maksimumnot) If ((enyukseknotmu And Not oncekienyukseknotmu) _ And gecerlinotmu) Then End If If (((notum > enyukseknot) And (notum <> enyukseknot)) And (notum < maksimumnot)) Then End If Veri tipi bool olan değişkenleri direkt olarak kullanın. = ya da not ile tekrar işleme sokmayın. If (donendeger) Then End If If (Not donendeger2) Then End If If (donendeger = true) Then End If If (donendeger2 = false) Then End If 27

32 Visual Basic.NET Kodlama Standartları Koşul yapılarında gereksiz yere koşulun tersini if ile kullanmayın. Bunun yerine else kullanın. If (donendeger) Then MessageBox.Show("True Döndü") Else MessageBox.Show("False Döndü") End If If (donendeger) Then MessageBox.Show("True Döndü") End If If (Not donendeger2) Then MessageBox.Show("False Döndü") End If İç içe if blokları yerine mümkünse else if yapısı kullanın. If (ilkdeger > ikincideger) Then MessageBox.Show("1. değer büyük") ElseIf (ilkdeger < ikincideger) Then MessageBox.Show("2. değer büyük") Else MessageBox.Show("2 side eşit") End If If (ilkdeger = ikincideger) Then MessageBox.Show("2 side eşit") Else If (ilkdeger > ikincideger) Then MessageBox.Show("1. değer büyük") Else MessageBox.Show("2. değer büyük") End If End If 28

33 v Select Deyimleri Sıralı koşul durumlarının değerlendirilmesine gerek olmayan, belirli bir değere göre belirli bir işlemin yapılması gereken durumlarda Select kullanın. Select deyiminde mümkün olduğunca listeleme (enum) kullanın. public enum CompressionFormat Zip, Gzip, Rar end enum Public Sub Compress(ByVal CompressionFormat As format) Select Case format Case CompressionFormat.Zip CompressWithZip() Exit Select Case CompressionFormat.Gzip CompressWithGzip() Exit Select Case CompressionFormat.Rar CompressWithRar() Exit Select Case Else CompressWithZip() Exit Select End Select public enum CompressionFormat Zip, Gzip, Rar end enum Public Sub Compress(ByVal CompressionFormat As format) If Format = CompressionFormat.Zip Then CompressWithZip() ElseIf Format = CompressionFormat.Gzip Then CompressWithGzip() ElseIf Format = CompressionFormat.Rar Then CompressWithRar() Else CompressWithZip() End If 29

34 Visual Basic.NET Kodlama Standartları Mutlaka "Case Else" ile beklenmeyen verileri kontrol edin. Public Enum CompressionFormat.. End Enum Public Sub Compress(ByVal CompressionFormat As format) Select Case format Case CompressionFormat.Zip CompressWithZip() Exit Select Case Else CompressWithZip() Exit Select End Select Public Sub Compress(ByVal CompressionFormat As format) Select Case format Case CompressionFormat.Zip CompressWithZip() Exit Select Case CompressionFormat.Gzip CompressWithGzip() Exit Select Case CompressionFormat.Rar CompressWithRar() Exit Select End Select 5.5 For / Foreach Deyimleri Bu iki döngü tipinde, döngü değişkenini aksi gerekmedikçe döngü içinde tanımlayın. Dim test() As String = {"bir", "iki", "üç"} For i As Integer = 0 To test.length - 1 MessageBox.Show(test(i)) Next Dim i As Integer Dim test() As String = {"bir", "iki", "üç"} For i = 0 To test.length - 1 MessageBox.Show(test(i)) Next Dim test As String = "bir,iki,uc" For Each item As String In test.split(",") MessageBox.Show(item) Next 30

35 v1.0 Dim test As String = "bir,iki,uc" Dim item As String For Each item In test.split(",") MessageBox.Show(item) Next 5.6 While/do-while Deyimleri While döngüsü ve do-while döngüsünün formu aşağıda ki gibidir; While koşul '... End While Do '... Loop While koşul While True If Not koşul Then Exit While '... End If End While Do '... If Not koşul Then Exit Do End If Loop While True 31

36 Visual Basic.NET Kodlama Standartları 5.7 İstisnai Durum Yönetimi Throw-catch-finally bloğunun yapısı aşağıdaki gibidir. Asla boş bir catch bloğu tanımlamayın. Throw-catch pahalı bir işlemdir. Bunu akış denetimi için kullanmayın. Değerlendirmeyeceğiniz istisnai durumu yakalamayın. Catch bloğu içinde try-catch kullanmaktan kaçının. İstisnai durum yakalanmasını en çok yakalanma olasılığı olandan en azına doğru sıralayın. Finally bloğunda try için ayrılan kaynağı salıverin. Try ' Đstisnai durum oluşma ihtimali olan kod Catch ex As Exception ' Oluşan durumu rapor et. Throw Finally ' try bloğu içinde kullanılan kaynağın salıverilmesi. End Try Try ' Đstisnai durum oluşma ihtimali olan kod Catch Throw Finally ' try bloğu içinde kullanılan kaynağın salıverilmesi. End Try Oluşan istisnai durumu tekrarlamaktansa iletmeyi tercih edin. Catch ex As Exception ' Oluşan durumu rapor et. Throw Catch ex As Exception ' Oluşan durumu rapor et. Throw ex 32

37 v1.0 İstisnai durumlardan kaçınmak için önce kontrol etmeyi tercih edin. If connection.state <> ConnectionState.Closed Then connection.close(); End If Try connection.close(); Catch ex As Exception ' Oluşan durumu rapor et. End Try Catch bloğu içinden farklı bir exception fırlattığınızda mutlaka innerexception özelliğine oluşan istisnai durumu ekleyin. Bu şekilde Call Stack zincirini bozmamış olursunuz. Try ' Đstisnai durum oluşma ihtimali olan kod Catch ex As Exception ' Oluşan durumu rapor et. Throw New Exception( "istisnai durum açıklaması", ex ) End Try Try ' Đstisnai durum oluşma ihtimali olan kod Catch ex As Exception ' Oluşan durumu rapor et. Throw New Exception( "istisnai durum açıklaması" ) End Try 33

38 Visual Basic.NET Kodlama Standartları Đndeks A Ara birim , 20 B Blok açıklama Boşluklar , 10 D Dokümantasyon , 13 F For , 15, 30 Foreach , 30 G Girintileme , 10 İ İsim alanı , 10, 19 İstisnai durum , 32 K Kısaltmalar , 17 M Metot , 14, 23 O Olay , 3, 14, 23 Ö Özellik , 3, 14, 23 P Parametre , 14, 22 R Return , 9, 11, 12, 16, 18, 19, 23, 26 S Sabit , 3, 22 Salt okunur Sınıf , 3, 8, 14, 17, 20, 35 Statik , 22 Switch , 28 T Tek satırlık açıklama

39 v1.0 TiKS (Türkçe içerikli Kodlama Standartları) Proje Ekibi Kadir ÇAMOĞLU Kadir ÇAMOĞLU, 1974 İstanbul doğumludur yılından itibaren profesyonel olarak yazılım projelerinde görev alan ÇAMOĞLU, 1993 yılından sonra eğitim sektöründe de yer almıştır. Microsoft un yazılım üzerine birçok sertifikasına sahip olan ÇAMOĞLU nun Pusula, Alfa ve Kodlab yayınevlerinden çıkan on adet kitabı bulunmaktadır. Bilgisayar mühendisliği doktora öğrencisi olan ÇAMOĞLU, BilgeAdam Kurumsal da yazılım ve veri tabanı danışmanı olarak çalışmaktadır. Volkan ATASEVER Yazılım Dünyasına BASIC ve C/C++ dili üstünde uygulamalar geliştirerek adım atan Volkan daha sonra C# ve VB.NET, Java dilleri ile uygulamalar geliştirmiştir. Haziran 2010 tarihinde ise Bilgisayar Mühendisliği kıyafetini giymiştir. Ineta topluluklarında uzun zaman yazarlık ve editörlük yaptıktan sonra DeveloperMania.Net sitesinin topluluk lideri olmuştur. INETA User Group Lead olarak çeşitli çalışmalar yapmaktadır. Yazılım Uzmanlığı ve Danışmanlığı yapmaktadır. Microsoft'un Akademik sitesi MSAkademik.Net de VB.NET editörlüğü yapmıştır. Konuşmacı olarak çeşitli üniversite ve eğitim merkezinde seminer vermektedir. Microsoft'un Türkiye de sadece 18 kişiye verdiği Sharepoint Server sertifikasını almıştır. Mobil uygulamalar, ASP.NET, MOSS 2007, SQL Server ve Windows geliştirmeleri içeren projelerde görev almaktadır. Bilgisayar ve teknoloji dergilerinde yazarlık yapmaktadır. Şu anda PCWorld dergisinde yazmaktadır. Ulusal Akademik Konferanslarda akademik bildiri ve makale yazarak bilime katkıda bulunmaktadır. Bilgisayar Mühendisi olarak çalışmalarını sürdürmektedir. Merve CEYLAN 2001 yılında lisede programlama eğitimi almaya başlayan Merve Ceylan, 2007 yılında Marmara üniversitesi Teknik eğitim fakültesi - bilgisayar teknolojileri ve programlama bölümünü bitirmiştir. Halen eğitimine devam etmekte olup işletme bölümü öğrencisidir. Üniversiteye devam ederken TÜBİTAK ta 2 yıl genel muhasebe projesinde yazılım uzmanı olarak çalışmıştır. Şuan 3 yıldır devam etmekte olduğu Maltepe Üniversitesi öğrenci işleri otomasyonu projesinde proje sorumlusu olarak görev almaktadır. Bu yıllar içinde farklı şirketlerin el terminalli restoran otomasyonu ve pazar araştırması projelerinde de çalışmıştır. Burhan ÇETİNKAYA 2005 senesinde yazılım dünyasına lisede Veri tabanı Programcılığı Bölümüne başlayarak giriş yapmıştır senesinde Türkiye çapında gerçekleşen bir yazılım geliştirme yarışmasında Türkiye ikinciliğiyle gümüş madalya kazandı. Birçok orta çapta Windows - Based Client ve Enterprise uygulamalarda proje yöneticisi ve yazılım uzmanı olarak görev aldı. Şuan 1. Sınıf öğrencisi olarak Yeditepe Üniversitesi Bilgisayar ve Öğretim Teknolojileri Öğretmenliği eğitimime devam etmektedir. 35

40 Visual Basic.NET Kodlama Standartları Bahtiyar DİLEK 1984 Amasya doğumlu olan Bahtiyar DİLEK, 16 yaşından beri programlamayla uğraşmaktadır yılında Bilimer Bilişim Akademisinden aldığı eğitimle MCPD olmuştur. Sharepoint Developer sertifikası olan Bahtiyar, halen Bilgisayar Mühendisliği öğrencilerine danışmanlık yapmaktadır. İrfan MEVSİM 1982 Tekirdağ doğumlu olan İrfan Mevsim, Marmara Üniversitesi Bilgisayar ve Kontrol Öğretmenliği 2005 mezunu yılından bu yana gelen amatör programlamanın üzerine 2007 yılında Türkiye nin en büyük beyaz eşya üreticilerinden birinde profesyonel anlamda programlayama başladı. Burada geçen 3 yılın ardından şu anda işletme içinde ihtiyaç duyulan tüm otomasyon ile entegre, mobil ve SAP bağlantılı sistemler üzerine uygulama geliştirebilir durumda. Can YAPAN 2006 yılında Bulgaristan Varna Teknik Üniversitesinde, Bilgisayar Sistemleri ve Teknolojileri bölümünde eğitimine başlamıştır. Eğitimi sırasında C# dili ve.net teknolojileri ile ilgilenmiş ve birkaç projede yer almıştır. Halen freelancer yazılım geliştirip eğitimine devam ediyor. Hakan YAVUZ 2006 senesinde Asp ile Web programcılığına başladım. Ardından Visual Basic 6.0 ile devam edip daha sonrasında tekrar web programlama ile devam etme kararı alıp php ve client tabanlı dilleri öğrenmeye başladım (javascript,ajax) daha sonra.net in gelişmesi ve yaygınlaşması ile beraber c#.net ve vb.net ile devam etmekteyim. Fakat ağırlığım web programlama üstünde. Yücel YILDIRIM Yücel YILDIRIM, 1981 Sivas doğumludur.2005 yılı Marmara Üni. Bilgisayar Mühendisliği mezunu olup, beş yılı aşkındır yazılım dünyasında aktif olarak rol almaktadır. Şu an bir bankanın bilgi işlem bölümünde çalışmaktadır. 36