วิธีสร้างความคิดเห็นซ่อน (Hidden Comments) ใน HTML

HTML Comments ใช้สำหรับใส่บันทึกในโค้ดที่ browser จะไม่แสดงผล ช่วยให้ developer อ่านโค้ดเข้าใจง่ายขึ้น

รูปแบบ

<!-- นี่คือความคิดเห็น จะไม่แสดงใน browser -->

การใช้งาน

• อธิบายโค้ดที่ซับซ้อน
• ปิดบล็อกโค้ชั่วคราว (disable code)
• ทำเครื่องหมายตำแหน่ง section ()
• ใส่ข้อมูล copyright, author, version

ตัวอย่าง

<!DOCTYPE html>
<html>
<head>
  <title>HTML Comments</title>
</head>
<body>
  <!-- This is a comment. -->
  <p>
    <!-- This is a comment inside paragraph -->
    This is demo text.
  </p>
</body>
</html>

ข้อจำกัด

• ไม่สามารถซ้อน comment ได้ (nested comments) - จะจบที่ --> แรกที่เจอ
• ไม่ควรใส่ข้อมูลละเอียดอ่อน (password, API key) เพราะดูได้จาก View Source
• conditional comments ใช้รูปแบบ <!--[if IE]>...<![endif]--> แยกต่างหาก

แนวทางปฏิบัติที่ดี

เขียน comment เป็นภาษาอังกฤษหรือไทยให้ชัดเจน สั้นกระชับ อธิบาย "ทำไม" ไม่ใช่แค่ "ทำอะไร"