توضیح ()
«توضیح (Comment)» یعنی متن راهنما برای خودت و تیمت. این متن در مرورگر دیده نمی شود. فقط در کُد می ماند و فهمیدن پروژه را ساده تر می کند.
تعریف و کاربرد تگ توضیح
تگ توضیح داخل سورس می آید. مرورگر آن را نمایش نمی دهد. با آن منطق کُد را توضیح بده. بعدا ویرایش کُد ساده تر می شود.
نمونه سریع از توضیح
<!-- This is a comment. Comments are not displayed in the browser -->
<p>This is a paragraph.</p>
نکته قدیمی: پنهان سازی اسکریپت
قدیما برای مرورگرهای بدون جاوااسکریپت، اسکریپت را در توضیح می گذاشتند. امروز معمولا نیاز نیست، اما الگو را ببین.
<script type="text/javascript">
<!--
function displayMsg() {
alert("Hello World!");
}
//-->
<\/script>
پشتیبانی مرورگر و ویژگی ها
همه مرورگرها تگ توضیح را می شناسند. این تگ هیچ ویژگی استاندارد و هیچ رویدادی ندارد.
راهنمای کوتاه استفاده
- فقط توضیح بنویس؛ کُد اجرا نمی شود.
- توضیح طولانی را چند خطی کن.
- توضیح بیهوده ننویس؛ هدف را بگو.
نکته: برای موضوعات مرتبط، صفحه تگ DOCTYPE را ببین. همچنین برای به روزرسانی زنده، رویدادهای ارسالی از سرور مفید است.
توضیح () را به عنوان کلیدواژه داخلی هم استفاده کردیم.
جمع بندی سریع
- توضیح دیده نمی شود؛ فقط در سورس است.
- برای توضیح منطق کُد عالی است.
- ویژگی و رویداد ندارد.
- الگوی پنهان سازی اسکریپت قدیمی است.