Visual Studio Summary Nedir ve Nasıl Kullanılır?

Visual Studio Summary Nedir ve Nasıl Kullanılır?

Visual studio da kod yazarken farketmişsinizdir. Örn bir msgbox kullanırken hangi parametrenin ne işe yaradığının açıklaması vardır. O nasıl yapılır?

Selamlar,

Bu dersin içeriği;

  • Summary nedir?
  • Summary nasıl hazırlanır?
  • Visual studio da summary nasıl kullanılır?

Summary

Summary nedir?

Summary, parametreli metodlarda, parametleri yazmak için parantez açtığınızda ilk parametrenin ne olduğu, değişken tipi, ne işe yaradaığı gibi bilgileri bize bir gösterdiği baloncuğa verilen addır. Şöyle ki, diyelim bir mail gönderme metodunuz var ve bir çok parametre alıyor. Şimdi bir yerde kullanmanız gerekti ve yazmaya başladınız.

yazdığınızda size resimdeki bir baloncuk açtı. İşte buna summary denir. Nadir kullandığınız metodlardaki aldığınız parametlerini amaçlarını zamanla unutabilirsiniz ancak summary kullandığınıza bu size o parametrelerin ne işe yaradığını söyleyecektir.

Tabi tekrar baktığınızda anlayacağınız şekilde yazdıysanız!!.

Summary nasıl hazırlanır?

Şimdi Summary'nin ne olduğunu anladık. Sıra geldi bunu nasıl yapacağımıza?

Summary özelliğini bilmediğiniz zamanlarda yorum satırı yapmak istediğinizde yanlışlıkla iki " // " yerine " /// " tane attığınızda otomatik olarak parametre sayısına göre satırlar getirdiğini görmüşsünüzdür. Hatta "La bunlar ne?" deyip geri silmişsinizdir.  Bende öyle oldu

Arkadaşlar işte o otomatik eklenen satırlar summary oluyor. Örneğini görelim:

Yazım şeklide resimdeki gibidir. Tanıdık geldi mi?

Şimdi bunu inceleyelim.

 /// <summary>
 /// 
 /// </summary>

Bu kısım metodumuzun genel tanımı için verilen alandır. Metod ne işe yarıyor?, hangi işlemleri yapıyor?, amacı nedir? gibi soruların cevaplarını yazacağınız alandır. Parametrelerin sıralı gösterildiği satırın altında yazar.

/// <param name="mail_adresi"></param>

Bu kısım(lar) parametre sayısı kadar otomatik eklenir ve o parametrenin açıklamasını yazacağınız yerdir. O parametre ne işe yarıyor?, hangi işlemleri yapıyor?, amacı nedir? gibi soruların cevaplarını yazacağınız alandır. Parametreleri yazmaya başladığınızda açıklamalarda çıkar. "," ile diğer parametreye geçtiğinizde parametre açıklaması da değişir.

/// <returns> </returns>

Bu kısım ise ilgili metodun geri dönderdiği derğer hakkında bilgi verir. Ancak metodunu yazarken summary baloncuğu içerisinde görünmüyor. En azından ben görmedim.

Visual studio da summary nasıl kullanılır?

Metodunuzu hazırladınız. Parametreleri vs herşey tamamlandı. 

Açık renkli satırı görüyorsunuz. Tanım satırının hemen üst satırı. O satıra gelip " /// " yazdığınız anda tüm satırlar otomatik olarak eklenmektedir. Yazacaklarınız da artık size kalmış. Parametre olmayan metodlarda da çalışır. Parametre almıyor diye yazılmaz diye bir şey yok. Her metod için yazabilirsiniz

NOT: Ekip işlerinde yani bir ekip ile çalıştığınızda summary ve yorum satırları hayati önem taşımaktadır. Yazdığınız kodlar ne işe yarıyorsa diğer adam gelip baktığında olayı hemen kavraması gerekir. Ona göre açıklayıcı bir şekilde yazmalısınız.

Bu dersimizde bu kadar arkdaşlar.

Bol Kodlu Günler.

Mustafa BÜKÜLMEZ
Web sitesi ve ERP, MRP, CRM ve kişiye özel uygulamalar uygun fiyatlarla hazırlanır. Fİyat için mesaj atabilirsiniz. -- Deneyip çalıştığını onaylamadan çok nadir ders eklerim. Denemediklerim ise eski makalelerimdendir. Hem bildiklerimi paylaşmak hemde her seferinde aramamak için yayınlıyorum. -- *Bilgi paylaştıkça çoğalır. *Bir mum diğer mumu yakmakla ışığından bir şey kaybetmez. Aksine Daha çok ışık yayar. -- 1992 İstanbul doğumluyum. Kahramanmaraş'ta yaşıyorum. Lise: Ağ sistemleri ve Yönetimi, Üniversite: Bilgisayar Programcılığı.. -- 07.2014 tarihinden beri bir firmada Bilgi İşlem Müdürü olarak çalışmaktayım. -- Kişisel Bloğum : https://csharpiledundenbugune.blogspot.com.tr/
Yorum Yaz

Yorum yazabilmek için üye girişi yapmanız gerekiyor!

Yukarı Git