افزودن توضیحات به پروژه

گاهی اوقات لازم است توضیحاتی در میان کدها بنویسیم تا به خودمان یا دیگران کمک کند درک سریع‌تر و دقیق‌تری از کد داشته باشیم. به این توضیحات که هیچ تأثیری در اجرای کد ندارند کامِنت / توضیح (Comment) می‌گویند. به دو صورت می‌توانیم این توضیحات را به کد اضافه کنیم.

نحوه استفاده از توضیحات تک خطی

Console.WriteLine(fullNmae);  // Bill Gates

بعد از // (دو اسلش) توضیحات را می‌نویسیم و این توضیحات هیچ تأثیری در اجرای کد ندارند. در این مثال عبارتی را که در کنسول نمایش داده می‌شود به‌صورت کامنت نوشتیم.

در صورتی‌ که توضیحات شامل کلمات فارسی و انگلیسی باشد، به‌صورت زیر نمایش داده می‌شود:

// این توضیحات شامل کلمات فارسی و  English می باشد.

نحوه استفاده از توضیحات چند خطی

/*
    این کامنت چند خطی است
    و می تواند شامل هر نوع راهنمایی، توضیحات،
    یادداشت و هر نوع اطلاعات مازاد بر کد نوشته شده باشد
 */
 Console.WriteLine("Hello World");

توضیحات چندخطی را بین /*...*/ قرار می‌دهیم.

باید ها و نباید های استفاده از توضیحات در کد

توضیحات در کد باعث می‌شوند که خودمان (یا دیگران) در آینده متوجه شویم که چرا یک بخش خاصی را در کد نوشته‌ایم یا چرا به شکل خاصی نوشته‌ایم یا در آینده باید بخش خاصی را به کد اضافه کنیم یا اطلاعات دیگری مازاد بر کد به خواننده داده شود.

همان‌طور که قبلاً گفتیم، نام‌گذاری‌ها را باید به گونه‌ای انجام دهیم که با دیدن نام متغیر متوجه ماهیت و کارایی متغیر شویم و به بررسی کدهای بالا و پایین متغیر نیازی نداشته باشیم. از کامنت برای مواردی استفاده می‌کنیم که به توضیح بیشتری نیاز داشته باشیم.

از افزودن توضیحات غیرضروری به پروژه اجتناب کنید. کد باید به‌صورتی نوشته شود که بتوان با خواندن آن متوجه عملکرد کد شد.