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