تو این جلسه میخواییم در مورد کامنت گذاری در HTML صحبت کنیم. کامنت گذاری در تمام زبان های برنامه نویسی از اهمیت بالایی برخوردار است . ما از Comment برای راهنمایی و تفسیر درون کدهای برنامه نویسی استفاده می کنیم و برای کاربر قابل مشاهده نمی باشد.
اهمیت کامنت گذاری در مستندات کدنویسی
یکی از دلایلی که اکثر ما برای کدهایمان کامنت نمی نویسیم این هست که آن را با اهمیت نمیدانیم و سعی داریم بیشتر برای کدنویسی برنامه خود وقت صرف کنیم . ولی اگر کامنت گذاری در کدنویسی هایمان صورت نگیرد بیشتر موجب به سردرگمی در زمان توسعه برنامه و یا … می شود.
ما باید کدنویسی را از ابتدا به صورت اصولی یادبگیریم و پیش ببریم.
1.توسعه بهتر برنامه
کامنت گذاری در زمان توسعه برنامه ی از قبل نوشته شده به ما بسیار کمک کرده و این روند برای ما راحت تر و سریع تر انجام میشود.
2.رفع راحت باگ ها با کامنت گذری
یکی دیگر از دلایل با اهمیت بودن مستند سازی در کدنویسی رفع باگ هاست . ممکن است درون کدهای ما باگ هایی به وجود بیاید و مدتی نیز از نوشتن کدها گذشته باشد و ما ندانیم که مثلا آن متغییری موجب به وجود آمدن باگ شده است را برای چه و در چه فایلی به کار برده ایم. در این صورت بای کل برنامه را بررسی کنیم تا بتوانیم باگ مورد نظر را بر طرف کنیم.
اما با یک کامنت گذاری مناسب قادر خواهیم بود به راحتی باگ های به وجود آمده را رفع کنیم.
3.کار تیمی
هنگامی که یک تیم بر روی یک پروژه کار میکنند ، ممکن است بخش های مختلف یک پروژه ای را با هم بخواهند کار کنند. اگر شخصی برای کدهای خود کامنت گذاری نکند و کد نویس دیگر بخواهد کدهای این شخص را توسعه دهد باید از او بپرسد که این متغییر چه کاری انجام می دهد و در کجا استفاده شده ، چرا این فانکشن نوشته شده ، برای چه این کلاس نوشته شده و…
این موضوع موجب کند پیش رفتن پروژه خواهد شد و این یک نوع هزینه است .
حال که با اهمیت کامنت گذاری در کدنویسی بیشتر آشنا شدیم . بهتر است به نحوه اننجام آن نیز بپردازیم.
نحوه کامنت گذاری در HTML
ما در هنگام نوشتن کدهایمان المنت های مختلفی را در صفحه یمان قرار می دهیم . هر کدام از این المنت ها وظیفه نمایش دادن چیزی را در صفحه ما دارند. به طور مثال ما میخواهیم درباره یک بخش section از کدمان توضیح دهیم که این بخش چه کاری را انجام می دهد و دلیل استفاده از آن چیست؟ و …
حتما در هنگام مشاهده کدهای یک صفحه به بلاک های از کد که معمولا به رنگ سبز هستند برخورد کرده اید. این بلاک های سبز رنگ که در تصویر زیر هم مشاهده میکنید کامنت است. توجه داشته باشید که این کامنتها توسط مرورگر به نمایش در نمی آیند.
ما سه نوع کامنت گذاری داریم که دو نوع آن مرسوم و رایج می باشد.
- کامنت تک خطی
- کامنت چند خطی
- کامنت شرطی
درباره HTML بیشتر بخوانید و حرفه ای شوید:
- ایجاد اولین سند html و آشنایی با ساختار صفحات آن
- آموزش تگ های تیتر یا heading – تاثیر تگ هدینگ html در سئو سایت
- آموزش تگ p یا پاراگراف در html و کاربردهای آن
- آموزش تگ تاکیدی strong و em در HTML
- آموزش تگ های br و hr در HTML و نکات آن ها
نحوه کامنت گذاری تک خطی در HTML
کامنت و توضیحات تک خطی را در سند HTML در بین تگ <– توضیحات ( Comment ) –!> و در یک خط قرار می گیرد. مانند:
<!DOCTYPE html> <html> <!-- Document Header --> <head> <title>مجموعه طراحی و سئو سایت متاوبز</title> </head> <!-- Document Header Ends --> <body> <p> با مجموعه طراحی و سئو سایت متاوبز همراه باشد تا بهتر و خاص تر دیده شوید.</p> </body> </html>
نحوه کامنت گذاری چند خطی در HTML
برای ایجاد یک کامنت چند خطی باید تگ –!> را در ابتدای خط اول و <– را در انتهای خط آخر قرار دهیم. و توجه داشته باشید دیگر نیاز به قرار دادن این تگ های در خطهای بین خط اول و آخر نیست. مانند:
<!DOCTYPE html> <html> <!-- This is a multiline comment and it can span through as many as lines you like. --> <head> <title>مجموعه طراحی و سئو سایت متاوبز</title> </head> <body> <p> با مجموعه طراحی و سئو سایت متاوبز همراه باشد تا بهتر و خاص تر دیده شوید.</p> </body> </html>
همیشه از کامنت ها در صورت لزوم و در مکان مناسب استفاده کنید و به دلایل اهمیت بالایی که کامنت گذاری در کد نویسی ها دارد هرگز استفاده از این تگ را فراموش نکنید.
اگر سوالی دارید ما اینجا هستیم تا به سوالات شما عزیزان پاسخ دهیم ، همراهتان هستیم ، مجموعه متاوبز.
