توضیحات JavaScript

توضیحات JavaScript برای توضیح کد JavaScript و افزایش خوانایی آن استفاده می‌شوند.

توضیحات JavaScript نیز می‌توانند برای جلوگیری از اجرای کد جایگزین در تست استفاده شوند.

توضیحات یک خطی

توضیحات یک خطی با // در ابتدا.

و هر چیزی که در // تمام متن بین توضیحات یک خطی و انتهای خط توسط JavaScript نادیده گرفته می‌شود (اجرا نمی‌شود).

این مثال از توضیحات یک خطی در ابتدای هر خط کد استفاده می‌کند:

مثال

// تغییر عنوان‌ها:
 document.getElementById("myH").innerHTML = "صفحه اول من";
// تغییر بخش‌ها:
 document.getElementById("myP").innerHTML = "متن اولین پاراگراف من.";

تست کنید

این مثال از توضیحات یک خطی در انتهای هر خط برای توضیح کد استفاده می‌کند:

مثال

var x = 5;      // تعریف x و اختصاص ارزش 5 به آن
var y = x + 2;  // تعریف y و اختصاص ارزش x + 2 به آن

تست کنید

توضیحات چندخطی

توضیحات چندخطی با /* شروع می‌شود، با */ پایان دارد.

و هر چیزی که در /* و */ 之间的文本都会被 JavaScript 忽略。

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

مثال

/*
 کدهای زیر تغییر می‌دهند
 در وب‌سایت
 عنوان‌هایی با id = "myH":
 و پاراگراف‌هایی با id = "myP":
*/
document.getElementById("myH").innerHTML = "صفحه اول من";
document.getElementById("myP").innerHTML = "متن اولین پاراگراف من."; 

تست کنید

نظری:استفاده از نظری خطی معمولاً رایج‌تر است.

توجه:بلوک‌های نظری معمولاً برای اعلان‌های رسمی استفاده می‌شوند.

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

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

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

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

مثال

//document.getElementById("myH").innerHTML = "صفحه اول من";
document.getElementById("myP").innerHTML = "متن اولین پاراگراف من."; 

تست کنید

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

مثال

/*
document.getElementById("myH").innerHTML = "صفحه اول من";
document.getElementById("myP").innerHTML = "متن اولین پاراگراف من.";
*/

تست کنید

خواندن در课外

آموزش‌های پیشرفته JavaScript: اسکریپت ECMAScript