آیا استفاده از کامنت ها ضرری برای ما دارد؟ استفاده از کامنت ها چه سودی می‌تواند برای ما داشته باشد؟ قرار دادن comment ها چه مزیتی را می‌تواند به سند HTML ما اضافه کند ؟ در این مقاله به مزایا و معایب استفاده از کامنت ها می‌پردازیم.
سرفصل‌های پست
یادآوری: تعریف کامنت
همانطور که در مقاله آشنایی با Comment ها در HTML گفتیم:
کامنت ها، قطعه کد هایی هستند که توسط مرورگر ها نادیده گرفته می‌شوند. معمولا از Comment برای شرح یک قطعه کد پیچیده، جدا سازی بخش ها یا نکات و یادداشت توسعه دهنده وب استفاده می شود. در یک کلام، کامنت‌ها به شما و دیگران کمک می کنند تا کد هایی که نوشته اید را درک کنند همچنین کامنت‌ها تاثیر شگرفی در افزایش خوانایی کد دارند.
بنابر این به قطعه کد هایی که ما برای راهنمایی و یادداشت نکات استفاده میکنیم و توسط مرورگر در نمایش نادیده گرفته می‌شود کامنت می‌گویند.
نمونه ای از کامنت
در زیر یک مثال برای معرفی کامنت استفاده کرده ایم.
<html> <head> <title> Mizfa Test </title> </head> <body> <!--- Hello Mizfa. This is Comment. ---> <p> Cons and Pros of comments in html </p> </body> </html>
در مثال بالا در بخش <!--- Hello Mizfa. This is Comment. ---> بخش کامنت ماست.
مزایا و معایب استفاده از کامنت ها
در استفاده از کامنت ما ممکن است که ندانیم که این قطعه کد می‌تواند تاثیراتی روی کد های ما بگذارد و استفاده از آن برایمان مزایا یا معایبی داشته باشد. طبق مقدمه موجود هدف از این مقاله توضیح در رابطه با مزیت ها و عیب های کامنت است.
عیب ها
از عیب ها شروع می‌کنم چون میزان عیب هایی که کامنت ها برای ما ایجاد می‌کنند نسبت به مزیت هایشان خیلی کمتر است و دوست دارم که خیلی سریع از این مبحث بگذریم و به مزایای مفیدی که استفاده از کامنت ها برایمان ایجاد می‌کنند اشاره کنم.
- استفاده از تگ Comment باعث اضافه شدن حجم کد‌های شما می‌شود.
از ایرادات بسیار مهمی که ممکن است ما به آن توجه نکنیم این است که با وجود کامنت ها حجم صفحات وب و کد های ما افزایش می‌یابد و با اینکه مرورگر ها از خواندن این قطعه کد ها چشم پوشی می‌کنند ولی آن‌ها را در هنگام بارگذاری لود می‌کنند و این باعث می‌شود که در لود صفحات ما حجم این قطعه کد ها نیز افزوده شود و کمی در سرعت ما تاثیر گذار باشند.
- کامنت گذاری وقت زیادی از شما می‌گیرد ولی در اجرای شما تاثیری ندارد
اگر بخواهیم یک پروژه بسیار بزرگ را کد نویسی کنیم کامنت گذاری برای این چنین پروژه هایی بسیار زمان بر است زیرا می‌بایست تک تک بخش هایی که ایجاد میکنیم را کامنت گذاری کنیم و این وقت بسیار زیادی از ما خواهد گرفت.
[box type=”success” align=”alignright” class=”” width=”800″]این نکته رو در نظر بگیرید که ایراد یا عیب اول با فشرده سازی کد هایمان امکان رفع است و همچنین ایراد یا عیب دوم نیز بستگی به میزان کوشش خودتون داره و تنبل نباشید صد در صد ایراد دوم هم نادیده میگیرید و کامنت گذاری را فراموش نمیکنید.[/box]
مزایا و اهمیت کامنت ها
همانطور که خواندید با عیب های استفاده از کامنت گذاری که قابل حل است آشنا شدیم. در این بخش می‌خواهیم با مزیت های استفاده از کامنت گذاری صحبت کنیم.
- دسترسی سریع به بخش مورد نظر
با استفاده از کامنت ها میتوانیم خیلی راحت و سریع بخش های مورد نظرمان را پیدا کنیم و تغییرات لازم را در آن بخش ها اعمال کنیم. با استفاده از این امکان علاوه بر اینکه دیگر نیازی به گشتن پی در پی در کد ها برای پیدا کردن بخشی از کد نیست.
- با استفاده از کد ها می‌دانید کدام بخشی چه عملکردی دارد یا مربوط به چه چیزی می‌شود
با استفاده از کامنت ها میتوانید عملکرد هر بخش را مشخص کنید تا در آینده با دیدن بخش های مختلف گیج نشوید و به صورت کامل در رابطه با هر بخش اطلاعات داشته باشیم. این کار باعث می‌شود سرعت بروزرسانی صفحات نیز افزایش یابد.
- با استفاده از کامنت کردن بخشی از کد میتوانید مشکلات را راحت تر حل کنید
در صورتی که بخشی از وب سایت ما به مشکل بر خورده باشد با کامنت کردن بخش های دیگر میتوانیم تنها آن بخش را در صفحه لود کنیم و مشکل را عیب یابی و حل کنیم.
- با استفاده از کامنت گذاری به برنامه نویس یا کد نویس بعدی احترام می‌گذارید
اگر در آینده قرار باشد که برنامه نویس یا کد نویسی به پروژه اضافه شود یا جایگزین شما شود یا حتی جز شما از پروژه به صورت شخصی استفاده کند، با کامنت گذاری شما میتوانید خیلی راحت منطق هر بخش را به او بفهمانید و علاوه بر اینکه شما به او با اینکار احترام گذاشته اید، او نیز سپاسگزار شما برای این کارتان خواهد بود.
پایانترم
[box type=”info” class=”question-from-users” width=””]سوال:
خیلی خلاصه بهمون بگو که چرا کامنت گذاری خوبه و آیا اجباری توی کامنت گذاری هست یا دلبخواهیه؟
به ایمیل کسانی که پاسخ درست و کامل رو در نظرات بگن ۱۰ هزارتومان در پنل کاربری آکادمی میزفا حسابشون شارژ میشه. (البته باید در آکادمی میزفا ثبت‌نام کنید تا بتونید از این امتیاز استفاده کنید.)
[/box]نتیجه گیری
همانطور که مشاهده کردید استفاده از کامنت ها می‌تواند مزایای خوبی برای شما داشته باشد و با کمی تلاش میتوانیم عیب های موجود را نیز حل کنیم.
پیشنهاد می‌کنم حتی برای کوچکترین پروژه های خود نیز از کامنت ها استفاده کنید تا علاوه بر اینکه خودتان در آینده میتوانید راحت تر کد هایتان را مدیریت کنید، اگر در زمان فورس نیازی به ورود برنامه نویس یا کد نویس دیگری به پروژه شما بود، آن برنامه نویس یا کد نویس نیز بتواند منطق کد های شما را درک کند.
این مقاله نیز به اتمام رسید و امیدوارم براتون مفید بوده باشه. تا مقاله بعدی فعلا …
5 پاسخ
جواب سوال:
مفیده چون وقتی مدت زیادی از نوشتن یه کد گذشته باشه ، با خوندن کامنت که حاوی توضیح در مورد اون کد هست بدون نیاز به فکر کردن زیاد در مورد رابطه کد با سایر قسمت ها و کاربردش می تونیم درک درستی از کاربرد کد در برنامه داشته باشیم که برای کد نویس (چه خودمون و چه دیگری) ارزش زیادی داره و مانع گیج شدن و خطاهای مربوطه و تا حدی مانع اتلاف وقت می شه و به اصطلاح خوانایی کد رو بالا می بره
از کامنت کردن قسمت های مختلف کد می تونیم برای بررسی دقیق تاثیر یه کد که مشکل داره کمک بگیریم
با کامنت گذاری درست می تونیم سریعتر قسمت مورد نظرمون رو داخل کدها پیدا کنیم
کامنت گذاری اختیاری هست اما نذاشتنش علی الخصوص در پروژه های تیمی نوعی ظلمه 🙂
باعث میشه ما راحت تر مشکل را در کد ها پیدا کنیم
با استفاده از کامنت میتوانیم به یک برنامه نویس دیگر کمک کنیم
با استفاده از کامنت ها میتوانیم خیلی راحت و سریع بخش های مورد نظرمان را پیدا کنیم
کامنت‌ها تاثیر شگرفی در افزایش خوانایی کد دارند.
اختیاری هست
ممنون علی اکبر، پاسخت درسته?
پاسخ سوال :
تقسیم کدها به بخش های مختلف
افزایش خوانایی کد توسط دیگران
فهم بهتر کد هم برای شخص برنامه‌نویس
برای توسعه برنامه یا رفع خطاها
صرفه‌جویی در وقت
اجباری در درج کامنت نیست.
سلام محمد، درست گفتی. ممنونم و هدیه‌ات رو توی حساب میزفا آکادمی شارژ میکنیم.