Computer >> บทช่วยสอนคอมพิวเตอร์ >  >> การเขียนโปรแกรม >> HTML

ความคิดเห็นใน HTML (HTML Comments): การเขียนและแนวทางปฏิบัติ

ความคิดเห็น HTML คืออะไร?

ความคิดเห็น (Comments) ใน HTML เขียนระหว่างแท็ก <!-- ... --> เนื้อหาภายในแท็กเหล่านี้จะ ไม่แสดงผลบนเบราว์เซอร์ แต่จะมองเห็นได้ในซอร์สโค้ด (View Source) ใช้สำหรับ:

  • อธิบายโค้ด ให้ผู้พัฒนาคนอื่น (หรือตัวเองในอนาคต) เข้าใจง่าย
  • ปิดการทำงานของโค้บบางส่วนชั่วคราว (Debugging)
  • จัดระเบียบโครงสร้างเอกสาร (เช่น แยกส่วน Header, Footer, Sidebar)

ความคิดเห็นบรรทัดเดียว (Single-line Comments)

<!DOCTYPE html>
<html>
<head>
  <!-- เริ่มส่วนหัวเอกสาร -->
  <title> tiêu đềเอกสาร </title>
</head>
<!-- จบส่วนหัวเอกสาร -->
<body>
  <p>เนื้อหาเอกสาร...</p>
</body>
</html>

ความคิดเห็นหลายบรรทัด (Multi-line Comments)

<!DOCTYPE html>
<html>
<head>
  <!-- 
    เริ่มส่วนหัวเอกสาร
    รวม meta tags, title, stylesheets
  -->
  <title> tiêu đềเอกสาร </title>
</head>
<body>
  <h2>หัวข้อระดับ 2</h2>
  <!-- 
    นี่คือความคิดเห็นหลายบรรทัด
    สามารถยาวได้เท่าไหร่ก็ตาม
    เหมาะสำหรับอธิบายตรรกะซับซ้อน
    หรือปิดบล็อกโค้ดขนาดใหญ่
  -->
  <p>เนื้อหาเอกสาร...</p>
  <p>มีความคิดเห็นในเอกสาร แต่ไม่แสดงผล</p>
</body>
</html>

ข้อจำกัดและข้อควรระวัง

หัวข้อ รายละเอียด
ไม่สามารถซ้อนกันได้ (No Nesting) <!-- outer <!-- inner --> outer --> จะจบที่ --> แรกที่เจอ
ห้ามมี -- ภายในความคิดเห็น บราวเซอร์บางตัวอาจตัดความคิดเห็นไม่ถูกต้อง หากมี -- อยู่ภายใน (ยกเว้นต้นและท้าย)
ไม่ซ่อนข้อมูลความปลอดภัย ความคิดเห็นมองเห็นได้ใน View Source อย่าใส่รหัสผ่าน, API Key, หรือข้อมูลลับ
ส่งผลต่อขนาดไฟล์ ความคิดเห็นเยอะมากเพิ่มขนาดไฟล์ HTML ควรลบก่อน Deploy ผ่าน Minification

แนวทางปฏิบัติที่ดี (Best Practices)

  • เขียนความคิดเห็นเป็นภาษาอังกฤษหรือไทยให้ชัดเจน สั้น กระชับ
  • ใช้ความคิดเห็นเพื่อทำเครื่องหมายส่วนต่างๆ ของหน้าเว็บ:
    <!-- Header Start --> ... <!-- Header End -->
    <!-- Main Content Start --> ... <!-- Main Content End -->
    <!-- Footer Start --> ... <!-- Footer End -->
  • ใช้ความคิดเห็นสำหรับ TODO/FIXME:
    <!-- TODO: เพิ่มการตรวจสอบฟอร์ม -->
    <!-- FIXME: แก้บั๊กการแสดงผลบนมือถือ -->
  • หลีกเลี่ยงความคิดเห็นที่อธิบายสิ่งที่โค้ดทำได้ชัดเจนแล้ว (เช่น <!-- เปิดแท็ก div -->)

ความคิดเห็นเงื่อนไข (Conditional Comments) - สำหรับ IE เท่านั้น

รองรับเฉพาะ Internet Explorer (IE 5-9) ใช้สำหรับโหลด CSS/JS เฉพาะ IE:

<!--[if IE]>
  <link rel="stylesheet" href="ie-only.css">
<![endif]-->

หมายเหตุ: ไม่ทำงานใน IE10+ และเบราว์เซอร์อื่นๆ ปัจจุบันแทบไม่ใช้แล้ว