کامنت‌های راهنما (XML Comment)

نام دوره: زبان سی شارپ مقدماتی

نویسنده: علی مقدم جاه (مدرس دوره)

کامنت کردن یک یا چندین خط، فارغ از نوع دستور یا توضیحاتی که در آن درج کرده‌اید، به طور کلی به سه بخش تقسیم می‌شوند:

۱. کامنت‌‌های تک خطی (Single Line Comments)
۲. کامنت‌های چند خطی ( Multiline Comment)
۳. کامنت ‌های راهنما (XML Comment)

کامنت‌های XML یا همان XML Comment ها برای یاری‌رسانی به برنامه‌نویس‌ها در زمان توسعه کد استفاده می‌شوند.

در محیط‌های عملیاتی و پروژه‌های واقعی، از XML کامنت‌ها برای مستندسازی مثلا متدها استفاده شده تا در آینده هنگام استفاده از آن متد در زمان فراخوانی، سیستم آن کامنت را به برنامه‌نویس به عنوان متن راهنما نمایش دهد.

برای استفاده از XML کامنت‌ها، باید بالای دستور تعریف شونده به عنوان مثال متد، ابتدا سه بار کاراکتر اسلش را درج کرده تا سیستم بصورت اتوماتیک متن پیش‌فرض را برای شما به نمایش درآورد، سپس می‌توانید طبق نیاز خود آن را ویرایش نمایید:

/// <summary>
/// متد سازنده کلاس کاربران
/// </summary>
/// <param name="UserId">آیدی کاربر</param>
/// <param name="Name">نام کاربر</param>
/// <param name="Family">نام خانوادگی کاربر</param>
/// <param name="Phonenumber">شماره موبایل کاربر</param>
/// <param name="Password">رمز عبور کاربر</param>
/// <param name="RoleId">نقش کاربر</param>
public User(int UserId, string Name, string Family, string Phonenumber, string Password, Role RoleId)
{
     this.UserId = UserId;
     this.Name = Name;
     this.Family = Family;
     this.Phonenumber = Phonenumber;
     this.Password = Password;
     this.RoleId = RoleId;
     Birthdate = DateTime.Now.AddYears(-25);
     RegisterDate = DateTime.Now;
     IsActiv = true;
}

نکته: سه کاراکتر /// دقیقا باید در خط بالای دستور مورد نظر درج شود تا سیستم بصورت اتوماتیک محتوای XML Comment را جهت ویرایش برنامه‌نویس، به بالای دستور اضافه کند.

نکته ۱: در بین تگ‌های باز و بسته summary باید یک نام آشنا که هر زمان با آن برخورد کردید، سریعا متوجه شوید که کار این مثلا متد چیست.

نکته ۲: باتوجه به ورودی‌های دستور خود که در مثال بالا یک متد است نیز برایتان یک تگ باز و بسته param توسط سیستم مشخص شده که می‌توانید برای آن ورودی‌ها نیز نام آشنایی برای خود در نظر گرفته و درج کنید.

جهت شرکت در دوره‌های زبان برنامه نویسی سی‌شارپ، از کد تخفیف heplc30 استفاده کنید.