اشتباهات

وقتی که کدی تایپ می کنید شاید بخواهید که متنی جهت یادآوری وظیفه آن کد به آن اضافه کنید. در سی شارپ (و بیشتر زبانهای برنامه نویسی) می توان این کار را با استفاده از توضیحات انجام داد. توضیحات متونی هستند که توسط کامپایلر نادیده گرفته می شوند و به عنوان بخشی از کد محسوب نمی شوند.
هدف اصلی از ایجاد توضیحات، بالا بردن خوانایی و تشخیص نقش کدهای نوشته شده توسط شما ، برای دیگران است. فرض کنید که می خواهید در مورد یک کد خاص، توضیح بدهید، می توانید توضیحات را در بالای کد یا کنار آن بنویسید. از توضیحات برای مستند سازی برنامه هم استفاده می شود. در برنامه زیر نقش توضیحات نشان داده شده است :

1 namespace CommentsDemo
2 {
3 class Program
4 {
5 public static void Main(string[] args)
6 {
7 // This line will print the message hello world
8 System.Console.WriteLine("Hello World!");
9 }
10 }
11 }
Hello World!
در کد بالا، خط 7 یک توضیح درباره خط 8 است که به کاربر اعلام می کند که وظیفه خط 8 چیست ؟ با اجرای کد بالا فقط جمله Hello World چاپ شده و خط 7 در خروجی نمایش داده نمی شود چون کامپایلر توضیحات را نادیده می گیرد. توضیحات بر سه نوعند :

توضیحات تک خطی
// single line comment
توضیحات چند خطی
/* multi
line
comment */
توضیحات XML
///

/// This is XML Idea
///

توضیحات تک خطی همانگونه که از نامش پیداست، برای توضیحاتی در حد یک خط به کار می روند. این توضیحات با علامت // شروع می شوند و هر نوشته ای که در سمت راست آن قرار بگیرد جز توضیحات به حساب می آید. این نوع توضیحات معمولا در بالا یا کنار کد قرار می گیرند. اگر توضیح درباره یک کد به بیش از یک خط نیاز باشد از توضیحات چند خطی استفاده می شود. توضیحات چند خطی با */ شروع و با /* پایان می یابند. هر نوشته ای که بین این دو علامت قرار بگیرد جز توضیحات محسوب می شود. نوع دیگری از توضیحات ، توضیحات XML نامیده می شوند. ا6ین نوع با سه اسلش (///) نشان داده می شوند. از این نوع برای مستند سازی برنامه استفاده می شود و در درس های آینده در مورد آنها توضیح خواهیم داد.