Visual Studio Summary Kullanımı

Visual Studio Summary Kullanımı, ile c sharp eğitimlerimize devam edelim. Bu yazımda başlıktan da anlayacağınız gibi visual studio üzerinden bir ders olacak. Bu derste bir kod yada yöntem de vermeyeceğim. Bu yazımda uzun zaman önce yazdığınız kodların bile kodları yazarken size yaptığı işlemi, aldığı parametrelerin amaçlarını, ne işe yaradıklarını gösterecek bir yöntem. Tabi bu açıklamaları ne kadar düzgün yazarsanız o kadar iyi anlarsınız. :) Zamanında Visual Studio summary ‘i kullanmak isteyip ama daha adının summary olduğunu bile bilmediğim bir zaman da forum sitelerinde ne çileler çekerek, uzun uzun açıklamak zorunda kalmıştım. Gelen cevap ise Summary olmuştu :D Görünce sizde “Bu mu yani Summary.” diyeceksiniz. :) Summary’i bilmeyen vs visual studio kullanan yazılımcıların %99’u buna denk gelmiştir. Hadi şimdi Visual Studio Summary Kullanımı nasılmış görelim.

Visual Studio Summary Kullanımı

Summary dediğimiz olayı açıklayayım ilk önce… Summary bir class, metod, void vs kod bloğunun ne iş yaptığını, aldığı parametrelerin ne işe yaradığını biz daha o kodu yazarken bir gösteren bilgi baloncuğudur. Hani MessageBox.Show yazıp parantez açıtğımızda alacağı parametler ekrana geliyor ya… Hah işe Summary dediğimiz olay tam olarak o…

Şimdi elimizde parametre alan bir metod olsun..

      string DenemeMetod (string Degisken1, string Degisken2, int Degisken3, object Degisken4)
        {
            return "";
        }

Şimdi bu metodumuza Summary uygulayalım.

        /// <summary>
        ///  Buraya Metodun yaptığı ana iş gelecek. 
        /// </summary>
        /// <param name="Degisken1"> Değişken1 'i  neden istiyoruz. </param>
        /// <param name="Degisken2"> Değişken2 'yi neden istiyoruz. </param>
        /// <param name="Degisken3"> Değişken3 'ü  neden istiyoruz. </param>
        /// <param name="Degisken4"> Değişken4 'ü  neden istiyoruz. </param>
        /// <returns> Dönüş değerleri </returns>
        string DenemeMetod (string Degisken1, string Degisken2, int Degisken3, object Degisken4)
        {
            return "";
        }

Yukarıdaki örnekte gördüğünüz gibi metodumuza summary uygulamış olduk. Şimdi metodumuzu yazarken nasıl görünecek ona bakalım.

Summary kullanılmadığında;

Summary kullanıldığında

Gördüğünüz gibi hangi parametreyi yazıyorsak açıklaması vs de ona göre değişiyor. İşte bu summary’dir. Ne kadar faydalı olabileceğini siz düşünün. :)

Şimdi her şeyi söyledik ama nasıl kullanacağız onu söylemedik. Korkmayın o kadar şeyi elle yazmıyorsunuz. Bir karaktere üç kere basıyorsunuz ve gerisini kendi oluşturuyor. :D

Bir satırı yorum satırı yapmak için çift slash kullanıyoruz. Summary içinse üç tane slash kullanıyoruz. Metodumuzun hemen üst satırına gelip /// yazdığımızda geri kalan her şey otomatik olarak oluşuyor. Metodunuz parametre almasa bile summary kullanabilirsiniz.

Visual Studio Summary Kullanımı yazımda bu kadar dostlar. Gerçekten her zaman kullanılması gereken ve çok faydalıdır.

C Sharp Eğitim Seti ve ERP Programlama ders listesi için tıklayınız. 

Takipte ve Sağlıcakla Kalın. ;)