گذاشتن توضیحات در جاوااسکریپت

گذاشتن توضیحات در جاوااسکریپت ، کامنت گذاری هنگام کد نویسی یکی از مواردی است که هر توسعه دهنده یا برنامه نویس حرفه ای باید رعایت کند. مخصوصا توابع و Function های پیچیده ای که در برنامه وجود دارد، نیاز به کامنت دارند؛ زیرا ممکن است، نفر بعدی که به سراغ کدهای شما بیاد، متوجه تابع شما شود و سردرگم نشود. پس کامنت گذاشتن برای نوشتن داستان نیست، بلکه برای کد یا تابع توضیح مختصر و مفید باید داد که یه برنامه نویس یا توسعه دهنده از تابع یا کدی که شما نوشتید، متوجه شود.

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

1. کامنت گذاشتن تک خطی

2. کامنت گذاشتن چند خطی

کامنت تک خطی در جاوااسکریپت

برای اینکه فقط یک خط از کد هایمان را کامنت کنیم تا پردازش نشود از اسلاش یا slash به صورت // استفاده میکنیم. در زیر مثالی از یک کامنت تک خطی در جاوا اسکریپت را میتوانید مشاهده کنید:

// Declare x, give it the value of 7
var x = 7;

کامنت چند خطی در جاوااسکریپت

این نوع کامنت زمانی کاربرد دارد که بخواهیم چندید خط از کدهایمان را کامنت کنیم. این کار به این صورت انجام میشود که خطوط کدمان را بین /*…*/ قرار میدهیم. در زیز نمونه ای از کامنت چند خطی را در جاوا اسکریپت میتوانید مشاهده کنید:

/*
Multi line comment
You can see here
shahcode.com
Declare x, give it the value of 7
*/
var x = 7;

مزایای کامنت گذاشتن

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

در جلسه ی بعد، موضوع متغیرها در جاوااسکریپت را بررسی میکنیم.

پس با ما همراه باشید.