کامنت گذاری یکی از مفاهیمی هست که هر برنامه نویسی باید بلد باشه و علاوه بر اون بتونه هوشمندانه از کامنت گذاری استفاده کنه. این مطلب بین همه زبان‌های برنامه نویسی مشترکه بنابراین من سعی کردم توی این مطلب به طور مفصل و البته خلاصه، ساده و شفاف کامنت گذاری رو بهتون توضیح بدم.
اصلا قصد ندارم توی این مطلب مقدمه چینی کنم یا بخوام از تاریخچه کامنت و کامنت گذاری صحبت کنم، بلکه هدفم اینه که متوجه این مبحث ساده اما خیلی مهم و کاربردی بشید و حین کار به خوبی ازش استفاده کنید. پس در ادامه این مطلب همراه من باشید.
کامنت گذاری یعنی چی؟
قبل از اینکه بخوام بگم چطوری بین کدهاتون کامنت بذارید، اول باید بهتون بگم کامنت اصلا چی هست؟. بیاید این قضیه رو با یه مثال ساده بررسی کنیم. فرض کنید میخواید با چندتا از دوستاتون برای تفریح برید کافه. توی این جمع چند نفر هستن که خیلی باهاشون راحت نیستید از طرفی محدودیت مالی دارید و نمی‌تونید بیشتر از 100 هزار تومن برای کافه هزینه کنید!!!. به همین دلیل هدفتون انتخاب کافه‌هایی هست که بتونید با این مبلغ اونجا چیزی سفارش بدید.
از اونجایی که با چند نفر از دوستان این جمع خیلی راحت نیستید نمی‌تونید بهشون بگید که فقط می‌تونید 100 هزار تومن هزینه کنید چون ممکنه شما رو قضاوت کنن و حس بدی به این موضوع دارید. بنابراین تصمیم می‌گیرید از دوستای صمیمی‌تون بخواید که تصمیم شما برای رفتن به یه کافه ارزون‌تر رو حمایت کنن. و این درخواست رو به شکلی انجام میدید که بقیه متوجه نشن و فقط خودتون متوجه این موضوع بشید.
کامنت گذاری دقیقا چنین کاربردی توی برنامه نویسی داره!!. فرض کنید به صورت گروهی روی یه پروژه کار می‌کنید و دوست دارید تکه کدها یا مطالبی رو توی فایل برنامه بنویسید که بقیه همکاراتون اونها رو ببینن اما کاربرهای نرم افزار شما نتونن این دستورات و یا نوشته‌ها رو ببینن. در چنین مواقعی از کامنت گذاری استفاده می‌کنیم.
کامنت گذاری در زبان‌های برنامه نویسی مختلف
در زبان C، #C، Java و… کامنت گذاری به دو شکل انجام میشه. اگه بخوایم یک خط رو کامنت کنیم، کافیه اول اون خط دو تا علامت اسلش (//) بذاریم. اما اگه نیاز داشتیم چند خط رو کامنت کنیم از */ در ابتدای کامنت و /* در انتهای خط استفاده می‌کنیم. برای مثال دستور زیر یک کامنت یک خطی رو نشون میده
// This is a one line comment
در حالی که دستور زیر نشون دهنده یک کامنت چند خطی هست
/* this is line 1 of comment
this is line 2 of comment
this is line 3 of comment */
اکثر زبان‌های برنامه نویسی از همین سینتکس (شیوه نگارش) برای کامنت گذاری استفاده میکنن اما در بعضی از زبان‌ها هم سینتکس کامنت گذاری متفاوته. برای مثال در زبان پایتون برای کامنت کردن هر خط از کد از علامت # در ابتدای اون خط استفاده میشه. برای مثال…
# this is a comment in python
همچنین در زبان SQL برای کامنت کردن هر خط از کد از علامت — در ابتدای اون خط استفاده میشه. برای مثال دستور زیر یک کامنت تک خطی رو در SQL نشون میده
— this is single line comment in SQL
همچنین دستور زیر نشون دهنده کامنت چند خطی در SQL هست
/* this is line 1 of comment
this is line 2 of comment
this is line 3 of comment */
اما کامنت گذاری توی زبان html (اگه نیاز به آموزش html داری می‌تونی از اینجا شروع کنی) یه مقداری عجیبه. دستور زیر نشون دهنده یک خط کامنت هست
<!– this is a comment in html –>
جالبه بدونید کامنت گذاری در Css مطابق کامنت گذاری در زبان C هست.
مراقب زامبی کامنت‌ها باشیم!!!
یه کار بد و اشتباهی که خیلی از برنامه نویس ها انجام میدن، کامنت کردن کدهایی هست که نسبت به درست و یا غلط بودنشون شک دارن. این یه کار طبیعیه که هممون انجام میدیم و خوب هم هست اما به شرطی که وقتی فهمیدیم کد به درد نمیخوره حذفش کنیم.
ما باید حد الامکان تعداد کامنت‌ها رو کاهش بدیم چون زیاد شدن تعداد کامنت‌ها در برنامه باعث میشه سرعت اجرای برنامه پایین بیاد خصوصا توی زبان‌های مفسری!. علاوه بر اون از اونجایی که وجود کامنت‌های به درد نخور توی فایل برنامه، که به اونها زامبی کامنت میگیم باعث میشه ساختار برنامه شلوغ و گیج کننده بشه. این موضوع خوانایی برنامه رو برای خودمون و سایر اعضای تیم برنامه نویسی کم میکنه و باعث میشه نگهداری برنامه سخت بشه.
بنابراین سعی کنید در مواقع ضروری از کامنت استفاده کنید و هر زمان که به کامنتی نیاز نبود همون موقع حذفش کنید.
