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

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


کامنت ها

در زبان جاوا اسکریپت برای شرح و توضیح کدی که نوشته شده است از کامنت ها استفاده می کنیم. کامنت ها می توانند تک خطی و یا چند خطی باشند.

برای ایجاد یک کامنت یک خطی از // و برای کامنت های چند خطی از /* ... */ استفاده می کنیم.

به صورت معمول از کامنت ها برای توضیح چگونگی عملکرد کد استفاده می‌کنند. استفاده از کامنت ها اگرچه اختیاری است ولی در بسیاری از موارد استفاده از آنها بسیار مفید است.


کامنت های تک خطی

کامنت های تک خطی با استفاده از دو کاراکتر اسلش (//) آغاز می شوند و باقیمانده خط تبدیل به کامنت می شود برای مثال :

function showPrimes(n) {
  nextPrime:
  for (let i = 2; i < n; i++) {

    // check if i is a prime number
    for (let j = 2; j < i; j++) {
      if (i % j == 0) continue nextPrime;
    }

    alert(i);
  }
}

کامنت های چند خطی

کامنت های چند خطی با استفاده از یک اسلش به همراه یک * آغاز شده (*/) و در پایان با (/*) خاتمه می یابند. برای مثال :

/**
 * Returns x raised to the n-th power.
 *
 * @param {number} x The number to raise.
 * @param {number} n The power, must be a natural number.
 * @return {number} x raised to the n-th power.
 */
function pow(x, n) {
  ...
}

نکته : محتویات کامنت ها نادیده گرفته می شوند. بنابراین اگر کدی را بین  /* ... */ قرار دهیم ، اجرا نخواهد شد. از این قابلیت می توان برای زمانی که می خواهیم قسمتی از کد به صورت موقت غیر فعال شود استفاده کرد.


کامنت های بد

تازه کار ها از کامنت ها برای توضیح دقیق عملکرد مجموعه ای از کد ها استفاده می کنند. برای مثال :

// This code will do this thing (...) and that thing (...)
// ...and who knows what else...
very;
complex;
code;

 اما در یک کد خوب چنین توضیحاتی برای کد بالا باید حداقل باشد و عملاً باید آنقدر واضح نوشته شده باشد که بدون کامنت ها قابل فهم باشد.

در این باره قانونی وجود دارد که باید در ذهن بسپارید :

     اگر کدی آنقدر واضح نباشد که نیاز به کامنت داشته باشد شاید نیاز باشد دوباره بازنویسی شود.

منتشر شده در ۲۶ خرداد ۱۳۹۷ حمید رضا ملکی ۲۱۱۰ بازدید
دیدگاه ها

هنوز دیدگاهی ثبت نشده

برای ارسال دیدگاه لازم است ابتدا وارد سایت شوید