تگ توضیحات در HTML

تگ توضیحات در HTML

تگ توضیحات HTML به منظور قرار دادن توضیحات در داخل کد استفاده می شود. خطوط توضیحات در HTML با تگ( –!>)  آغاز شده و با تگ (<–)  به پایان میرسد . تمام متن قرار داده شده در داخل این تگ ها توسط مرورگرهای وب نادیده گرفته شده و برای کاربر نامرئی هستند. استفاده از آن برای “پنهان کردن” کدهای اسکریپت و استایل از مرورگرهای قدیمی تر (که از آنها پشتیبانی نمی کنند) شایعتر است. اضافه کردن توضیحات در اسناد پیچیده به افرادی که به کدها نگاه می کنند کمک میکند که راحت تر آن را درک کنند . تگ توضیحات برای توسعه دهندگان وبی که به تازگی شروع به کار کرده اند بسیار مفید خواهد بود.

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

[php]<!–Start of Navigation Bar –>
Your navigation coding
<!–End of Navigation Bar –>[/php]

اکثر زبان های برنامه نویسی توضیحات دارند که برای مقاصد زیر استفاده می شود:

• توصیف و توضیح کدهای پیچیده
• ارائه جزئیات بیشتر در مورد زمانی که کد، ویرایش یا بررسی شده
• حذف بخشی از کد یا عدم استفاده از آنها تا زمانی مشخص
• گفتگو با دیگر توسعه دهندگان که بر روی این کدها کار میکنند

پنهان کردن کد ها از مرورگرهای قدیمی توسط تگ توضیحات

از تگ توضیحات، برای مخفی کردن کد های اسکریپتی که  بین <!– و –> قرار میگیرند، در مرورگرهای قدیمی تر که از این کدها پشتیبانی نمی کنند، استفاده میشود.

استفاده از توضیحات برای یافتن مشکلات

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

قواعد نوشتاری تگ توضیحات

باید اطمینان حاصل کنید که هیچ فاصله ای در هنگام نوشتن تگ شروع و پایان وجود نداشته باشد .

به عنوان مثال: خط زیر در HTML معتبر است:

[php] <!– This is commented out –>[/php]

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

[php] < !– This is commented out –>[/php]

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

در داخل توضیحات ممکن است ۲ خط فاصله (–) وجود نداشته باشد . از نظر فنی توضیحات با — به اتمام میرسد نه با <– اما در عمل تقریبا همه مرورگرها تا زمانی که به < نرسند توضیحات را پایان یافته در نظر نمیگیرند .

تمامی مثال های زیر نمونه ای از تگ توضیحات هستند

[php]
<!– Hello –>
<!– Hello — — Hello–>
<!—->
<!—— Hello –>
<!> [/php]

توجه داشته باشید که یک توضیح “خالی” که فقط از کاراکترهای “–” تشکیل شده است، همیشه باید چهار کاراکتر “-” داشته باشد تا قانونی به نظر برسد .البته وجود <!> نیز ضروری است . به عنوان مثال، ” <–hello <——!>”  یک توضیح است، که شما می توانید با قاعده بالا بررسی کنید. این یک تگ توضیحات است که شامل دو توضیح میباشد ؛ اولین توضیح خالی است و دومی شامل ” hello  < “. اگر شما آن را در یک مرورگر امتحان کنید ، این متن بر روی صفحه نمایش داده می شود.

دو نتیجه ممکن است حاصل شود:

مرورگر کاراکتر “<” می بیند و فکر می کند که توضیح به پایان رسیده است.

مرورگر “<–” را میبیند و فکر می کند که توضیح به پایان رسیده است.

مشکل دیگری نیز در استفاده از “–” وجود دارد. برخی از افراد عادت دارند که از چیزهایی مانند “<————–!>” برای جداکردن کدهای خود استفاده کنند. متاسفانه، در اغلب موارد، تعداد کاراکتر “-” مضربی از چهار نیست. این بدان معناست که وقتی مرورگر تلاش می کند آن را به درستی دریافت کند، در واقع آن را اشتباه تجزیه کرده و بقیه ی سند را پنهان میکند.

به همین دلیل، استفاده از قانون ساده زیر ، برای قرار دادن توضیحات، معتبر و مورد قبول است:

توضیحات HTML با “!>” آغاز شده و با “<–” ، به پایان می رسد و حاوی هیچ کاراکتری از “-” یا “<” در داخل توضیحات نیست . 

توضیحات چند خطی:

میدانید که چگونه یک خط توضیح در کدهای HTML وارد کنید . برای نوشتن چند خط در تگ شروع ( –!>) و تگ پایان (<– )  میتوانید بین خطوط از یک تگ شکست خط <br/> استفاده کنید . به عنوان مثال:

[php]
<!– This is a multiline comment <br />and can span through as many as lines you like.–>
[/php]

توضیحات شرطی

کامنت های شرطی تنها بر روی اکسپلورر و ویندوز کاربرد دارند و در نتیجه برای دادن دستورالعمل های ویژه ای که تنها در اینترنت اکسپلورر و ویندوز معنا پیدا می کنند فوق العاده مناسب هستند. توضیحات شرطی از اکسپلورر ۵ به بعد پشتیبانی میشوند و حتی ممکن است در نسخه ۵٫۰، ۵٫۵ و ۶٫۰ متفاوت باشد .

کامنتهای شرطی به صورت زیر است:

[php]
<!–[if IE 6]>Special instructions for IE 6 here<![endif]–>
[/php]

ساختار پایه این توضیحات شرطی در HTML همان ( <– –!>) است. بنابراین از دید سایر مرورگرها به عنوان یک توضیح معمولی در نظر گرفته میشود که آن را به طور کامل نادیده میگیرند.

اینترنت اکسپلورر طوری برنامه ریزی شده است که ساختار خاص <[if IE]–!>  را شناسایی کرده و محتوای کامنت شرطی را تجزیه میکند.

از آنجایی که توضیحات شرطی از ساختار توضیحات HTML استفاده میکند، فقط در فایلهای HTML (نه در فایل CSS) میتوان از آنها استفاده کرد.

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

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

[php]
<script><!– document.write("Hello World!")//–></script>
[/php]

توجه: دو اسلش قرار گرفته در پایان تگ توضیحات (//)نماد توضیحات جاوا اسکریپت است .

به طور مشابه، اگر شما از CSS در کد HTML خود استفاده میکنید، توصیه می شود توضیحات را در داخل کد شیوه نامه در HTML قرار دهید تا در مرورگرهای قدیمی به درستی کار کند.به عنوان مثال:

[php]
<style><!– img{ border:0px;}//–></style>
[/php]

خاصیت ها:

این تگ هیچ خاصیتی ندارد.

 رویدادها :

هیچ رویداد تعریف شده ای برای این تگ وجود ندارد.

 تفاوت بین HTML 4.01 و HTML5

بین تگ توضیحات در HTML 4.01 و HTML5 هیچ تفاوتی وجود ندارد .

 پشتیبانی مرورگر ها

تگ توضیحات در تمام مرورگرهای اصلی مانند اینترنت اکسپلورر ، فایرفاکس، اپرا ، گوگل کروم ، سافاری  پشتیبانی می شود.

 استفاده از تگ comment

تعداد کمی از مرورگرها برای قرار دادن توضیحات در کد، از تگ <comment> پشتیبانی میکنند که از این عنصر نباید استفاده شود:

[php]
<p>This is <comment>not</comment> Internet Explorer.</p>
[/php]