c# metot için açıklama, özet eklemek

Kodla Büyü

sfym

Seçkin Üye
Seçkin Üye
Mesajlar
384
.

Oluşturduğunuz metodu hem kendiniz hem de başkaları için anlaşılır hale getirmek için açıklama eklemek önemlidir.

public bool PersonelIslem (int cinsiyet)
{
işlemler...
}

Bunun için metodun hemen üzerindeyken 3 kere / karakterine bastığınızda (///) Visual Studio size otomatik olarak şu şablonu getirecektir:

/// <summary>
/// metodunuzun ne işe yaradığı vs bilgiler
/// </summary>
/// <param name="cinsiyet">Cinsiyet parametresine 1 ve 0 gönderiyoruz</param>
/// <returns>dönen değerimiz true ve false şeklindedir. true kayıt yapıldığını gösterir</returns>

şeklinde doldurduğunuzda:
metodu kullanmak istediğiniz yerde metodun adını yazdığınızda açıklamaları görebilirsiniz.
daha sonra baktığınızda ya da sizden sonra bakan için metodun anlaşılmasını sağlayabilirsiniz.

.
 
İki // yeterli. Şöyle :
// Açıklama...

Birden fazla açıklama satırı için şöyle yapılabilir:
/*
Açıklama...
Açıklama...
Açıklama...
*/
 
Geri
Üst