Sınıf ve Üyelere Açıklama Eklemek

Merhaba arkadaşlar,

özellikle üçüncü parti dll kütüphanerinde kullandığımız fonsiyonların işlevlerini bilmek işimizi kolaylaştırmaktadır. Bu yazıda kendi oluşturacağımız sınıf ve üyelerine açıklama ekleyeceğiz.

Basitçe oluşturulmuş bir toplama fonksiyonu aşağıdaki gibi iken;

public static class Hesaplamalar
    {
        public static double Topla(double p1, double p2)
        {
            return p1 + p2;
        }
    }

 Hesaplamalar statik sınıfı altındaki static Topla fonksiyonunu çağırmak istediğimde intellisense varsayılan açıklaması aşağıdaki resimdeki gibi olmaktadır.

 

Sınıf ve sınıf üyeleri tanımlalarının hemen üst satırına /// işareti eklediğimizde editör ilgili açıklama şablonunu oluşturmaktadır.Metod açıklamalarına her bir parametre için ayrı ayrı açıklama girilebilmektedir.

    /// <summary>
    /// Hesaplamalar sınıfı
    /// </summary>
    public static class Hesaplamalar
    {
        /// <summary>
        /// parametresine girilen değerleri toplar.
        /// </summary>
        /// <param name="p1">double türünden değerler virgül ile ayrılarak, ya da double bir dizi parametre olarak geçilebilir</param>
        /// <returns>double değer döndürür</returns>
        public static double Topla(params double[] p1)
        {
            return p1.Sum();
        }
    }

editörde metodu kullanmak istediğimizde intellisense açıklamayı getirecektir;

kütüphanenizdeki sınıf ve üyerine açıklamalar girerek hem kendinizin hem de paylaştığınız kullanıcıların sınıf ve üyelerinin amaçlarını hatırlamasını/anlamasını kolaylaştırmış olacaksınız.

Bir sonraki yazımda görüşmek üzere,

Yaşar Şahin