توضیحات در جاوا اسکریپت

از ویکی کد
پرش به ناوبری پرش به جستجو
Main Page Tutorial
JavaScript-menu.png
موارد آموزشی
فرم‌ها در جاوا اسکریپت
اشیاء در جاوا اسکریپت
تابع در جاوا اسکریپت
HTML DOM در جاوا اسکریپت
Browser BOM در جاوا اسکریپت
AJAX در جاوا اسکریپت
JSON در جاوا اسکریپت
جی‌کوئری در برابر جاوا اسکریپت
مثال‌های جاوا اسکریپت
مرجع جاوا اسکریپت

از قابلیت نظرات یا کامنت‌ها در جاوا اسکریپت می‌توان برای شرح وظیفهٔ کدهای جاوا اسکریپت استفاده کرد و استفاده از این قابلیت موجب خوانایی بیشتر کد می‌شود.[۱]

همچنین می‌توان از کامنت‌ها در جاوا اسکریپت برای جلوگیری از اجرای برخی از کدها در زمان تست جلوگیری کرد.

نظرات یک خطی

برای ایجاد نظرات یک خطی در جاوا اسکریپت می‌بایست در ابتدای این نظرات از علامت//استفاده کرد.

هر متنی که بین علامت//تا پایین خط قرار بگیرد توسط جاوا اسکریپت نادیده گرفته می‌شود. (اجرا نمی‌شود)

در مثال زیر، قبل از هر خط کد یک نظر یک خطی با استفاده از علامت // درج شده‌است:

1 // Change heading:
2 document.getElementById("myH").innerHTML = "My First Page";
3 
4 // Change paragraph:
5 document.getElementById("myP").innerHTML = "My first paragraph.";


در مثال زیر یک نظر یک خطی در انتهای هر خط کد، برای شرح وظیفهٔ آن تکه کد درج شده‌است:

1 var x = 5;      // Declare x, give it the value of 5
2 var y = x + 2;  // Declare y, give it the value of x + 2


نظرات چند خطی

نظرات چند خطی در جاوا اسکریپت با علامت*/آغاز می‌شوند و با علامت/*نیز پایان می‌یابند.

هر گونه متنی که بین علامت*/و/*قرار بگیرد توسط جاوا اسکریپت نادیده گرفته می‌شود.

مثال زیر از یک نظر چند خطی (یا یک بلاک کامنت) برای شرح وظیفه کد استفاده می‌کند:

1 /*
2 The code below will change
3 the heading with id = "myH"
4 and the paragraph with id = "myP"
5 in my web page:
6 */
7 document.getElementById("myH").innerHTML = "My First Page";
8 document.getElementById("myP").innerHTML = "My first paragraph.";


برنامه‌نویسان معمولاً از نظرهای یک خطی برای توضیح کدهای خود استفاده می‌کنند.

بلاک‌های کامنت‌ها اغلب برای سندسازی یا داکیومنت (به انگلیسی: documentation) سازی‌های رسمی استفاده می‌شوند.

استفاده از نظرات برای جلوگیری از اجرای کد

استفاده از نظرات برای جلوگیری از اجرای برخی از کدها روش مناسبی برای تست کردن کدها است.

اضافه کردندر ابتدای یک خط کد، آن کد را از حالت قابل اجرا به یک خط نظر تبدیل می‌کند.

این مثال از علامت//برای جلوگیری از اجرای یک خط از کدها استفاده می‌کند:

1 //document.getElementById("myH").innerHTML = "My First Page";
2 document.getElementById("myP").innerHTML = "My first paragraph.";


این مثال از یک بلاک از نظرات برای جلوگیری از اجرای چندین خط کد استفاده می‌کند:

1 /*
2 document.getElementById("myH").innerHTML = "My First Page";
3 document.getElementById("myP").innerHTML = "My first paragraph.";
4 */

منابع آموزشی