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

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

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

Free-Learn

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

نظرات یا کامنت ها یا توضیحات یا به انگلیسی Comments به اون دستور ( یا توضیحی ) گفته میشه که بخوایم نحوه عملکرد یک یا چندین دستور ( یا بخش و.. ) از یک سورس کد رو تعریف کنیم.

نه فقط زبان جاوااسکریپت بلکه تمامی زبان های برنامه نویسی و طراحی وب قابلیت اضافه کردن توضیح یا کامنت رو دارند ، از جمله زبان های PHP و HTML و CSS و #C و…

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

از ۲ روش میتونیم از توضیحات یا ( اسم رسمی ترش Comments یا کامنت یا نظرات ) در جاوااسکریپت استفاده کنیم ، که این روش ها به شرح زیر می باشد :

  • توضیح یا کامنت تک خطی یا ( سطری )
  • توضیح یا کامنت چند خطی ( چند سطری )

Free-Learn

توضیح یا کامنت تک خطی یا ( سطری )

همونطور که از اسمش هم مشخصه ، کامنت ها در یک خط یا یک سطری نوشته میشن ، و به راحتی میتونیم عملکرد کدهارو توضیح بدیم ، شکل کلی این روش بصورت زیر می باشد :

مثال :

امتحان کنید

Free-Learn

توضیح یا کامنت چند خطی ( چند سطری )

خب ممکنه بخوایم توضیحات مون رو در چندین سطر ( خط ) ارائه بدیم ، دیگه باید از این روش استفاده نماییم که شکل کلی بصورت زیر می باشد :

مثال :

امتحان کنید

Free-Learn

نکات و توضیحات

  • هرچیزی که به شکل کامنت یا نظر در صفحه ایجاد شده باشد توسط مرورگرها نادیده گرفته میشه و در نتیجه اون دستورات اجرا نمیشن.
  • استفاده بیش از اندازه ( یعنی اینکه بخواید خط به خط رو توضیح بدید ) از نظرات باعث میشه حجم دستورات و بطور کلی حجم فایل جاوااسکریپت بالا بره، که این زیاد جالب و بهینه نیست، لذا سعی کنید فقط موارد ضروری و خاص رو توضیح بدید.
  • یا هم میتونید ۲ صفحه ایجاد کنید، یکی دارای توضیحات و دیگری بدون توضیحات ، اونیکه بدون توضیحات هست رو بزارید تو سایتتون برای اجرا شدن. ( که حداقل حجم و .. بهینه باشه ) و اونیکه دارای توضیحات هست هم برای خودتون

Free-Learn

دریافت PDF یا پرینت این مطلب