CSS

CSS — کامنت ها در CSS (Comments)

آخرین بروزرسانی: 1404/07/12

کامنت های CSS (Comments): مستندسازی تمیز و امن

در این راهنما «کامنت های CSS» را معرفی می کنیم. کامنت (Comment) برای توضیح کد و غیرفعال سازی موقت بخش ها استفاده می شود. بنابراین مرورگر آن ها را نادیده می گیرد و شما بدون تغییر منطق، خوانایی را افزایش می دهید.

سینتکس کامنت های CSS

کامنت با /* شروع و با */ پایان می یابد. همچنین می توانید آن را در هر جای قانون قرار دهید؛ زیرا پارسر آن را حذف می کند.

/* توضیح تک خطی */
p { color: red; }
p { color: red; /* تعیین رنگ متن */ }
/* این یک
کامنت چندخطی است */
h1 { color: blue; }

نکته: می توانید حتی وسط یک مقدار، بخش هایی را موقتاً پنهان کنید؛ اما خوانایی را در نظر بگیرید.

p { color: /*red*/ blue; }

ترکیب کامنت های HTML و CSS

در فایل های HTML، می توانید هم زمان از کامنت HTML و CSS استفاده کنید. البته مرورگر خروجی هیچ کدام را نشان نمی دهد؛ بنابراین اسناد شما تمیز می ماند.

بهترین روش ها برای کامنت های CSS

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

هشدار: از «کامنت گذاری بیش ازحد» خودداری کنید؛ زیرا نگهداری را سخت می کند و نشتی دانش ایجاد می کند.

گام های بعدی

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