ความคิดเห็น HTML คืออะไรและใช้อย่างไร
เมื่อคุณดูเว็บเพจในเบราเซอร์คุณจะเห็นภาพที่แสดงว่าซอฟต์แวร์ชิ้นใด (เว็บเบราเซอร์) แสดงตามรหัสของหน้าเว็บหนึ่ง ๆ หากคุณ ดูซอร์สโค้ด ของเว็บเพจคุณจะเห็นเอกสารที่ประกอบขึ้นจากองค์ประกอบ HTML ต่างๆ ได้แก่ ย่อหน้าส่วนหัวรายการลิงก์ภาพและอื่น ๆ องค์ประกอบทั้งหมดนี้แสดงโดยเบราว์เซอร์ในหน้าจอของผู้เข้าชมซึ่งเป็นส่วนหนึ่งของการแสดงผลเว็บไซต์ สิ่งหนึ่งที่คุณอาจพบในโค้ด HTML ที่ไม่แสดงผลบนหน้าจอของบุคคลหนึ่งคือสิ่งที่เรียกว่า "ความคิดเห็น HTML"
ความคิดเห็นคืออะไร?
ความคิดเห็นคือสตริงโค้ดภายใน HTML, XML หรือ CSS ที่ไม่ได้รับการดูหรือดำเนินการโดยเบราว์เซอร์หรือโปรแกรมแบ่งวิเคราะห์ มีการเขียนลงในรหัสเพื่อเขียนข้อมูลเกี่ยวกับโค้ดดังกล่าวหรือข้อเสนอแนะอื่น ๆ จากนักพัฒนาโค้ด
ภาษาโปรแกรมส่วนใหญ่มีความคิดเห็นพวกเขามักใช้โดยนักพัฒนาโค้ดสำหรับหนึ่งหรือมากกว่าหนึ่งเหตุผลต่อไปนี้
- อธิบายและอธิบายรหัสที่ซับซ้อนให้กับคนที่อาจต้องใช้งานได้ในอนาคต - รวมถึงตัวเอง! พวกเขาอาจกลับมาที่รหัส 3 หรือ 6 ของ 12 เดือนหรือมากกว่าในภายหลังและไม่จำได้ว่าทำไมพวกเขาทำบางอย่างบางอย่าง ความคิดเห็นสามารถช่วยตอบคำถามของพวกเขาและเตือนพวกเขาได้ว่าจิตใจของพวกเขาอยู่ที่ใดเมื่อพวกเขาพัฒนาเพจนั้นเป็นครั้งแรก
- ระบุรายละเอียดเกี่ยวกับเวลาที่มีการแก้ไขหรือตรวจทานโค้ด ข้อมูลนี้อาจเป็นข้อมูลที่เป็นประโยชน์และทำหน้าที่คล้ายกับบันทึกการพัฒนาเมื่อเว็บไซต์ถูกใช้งานครั้งล่าสุด
- ลบส่วนของรหัส แต่ปล่อยให้พร้อมใช้งานในภายหลัง ซึ่งมักทำในระหว่างการทดสอบไซต์และดีบัก หากคุณมีปัญหาในไซต์และไม่แน่ใจว่าเกิดอะไรขึ้นคุณสามารถแสดงความคิดเห็นออกทีละส่วนเพื่อคัดค้านและระบุปัญหาและแก้ไขปัญหาที่คุณมีอยู่
- สนทนากับนักพัฒนาซอฟต์แวร์อื่น ๆ ที่ทำงานในโค้ด นี้อาจจะทำในระหว่างการพัฒนาเป็นวิธีการแบ่งปันรายละเอียดกับคนอื่น ๆ ที่ทำงานในรหัสในเวลาเดียวกัน หากความคิดเห็นเหล่านี้เป็นบทสนทนาเกี่ยวกับการพัฒนาอย่างหมดจดการปฏิบัติที่ดีที่สุดในการลบออกจากโค้ดก่อนเปิดตัวไซต์
ตามเนื้อผ้าความคิดเห็นใน HTML จะใช้สำหรับเกือบทุกองค์ประกอบจากคำอธิบายของโครงสร้างตารางที่ซับซ้อนต่อคำพูดที่เป็นข้อมูลของเนื้อหาของหน้านั้นเอง เนื่องจากความคิดเห็นไม่แสดงผลในเบราว์เซอร์คุณจึงสามารถเพิ่มที่ใดก็ได้ใน HTML และไม่ต้องกังวลกับสิ่งที่จะทำเมื่อไซต์ถูกดูโดยลูกค้า
วิธีเขียนความคิดเห็น
การเขียนความคิดเห็นในรูปแบบ HTML, XHTML และ XML ทำได้ง่ายมาก เพียงล้อมรอบข้อความที่คุณต้องการแสดงความคิดเห็นออกมาด้วยสิ่งต่อไปนี้:
และ ->ดังที่คุณเห็นความคิดเห็นเหล่านี้เริ่มต้นด้วย "สัญลักษณ์น้อยกว่า" รวมทั้งจุดประท้วงและเครื่องหมายขีดกลางสองขีด ความคิดเห็นจบลงด้วยเครื่องหมายขีดกลางอีกสองขีดและ "มากกว่า: สัญลักษณ์ระหว่างอักขระเหล่านั้นคุณสามารถเขียนสิ่งที่คุณต้องการสร้างขึ้นเพื่อแสดงความคิดเห็นได้
ใน CSS จะแตกต่างกันเล็กน้อยโดยใช้ความคิดเห็นของโค้ด C มากกว่า HTML คุณเริ่มต้นด้วยเครื่องหมายสแลชไปข้างหน้าด้วยเครื่องหมายดอกจัน คุณจะสิ้นสุดความคิดเห็นโดยใช้คำผกผันของเครื่องหมายดอกจันตามด้วยเครื่องหมายทับ
/ * ข้อความที่แสดงความคิดเห็น * /ความคิดเห็นเป็น Dying Art
โปรแกรมเมอร์ส่วนใหญ่ทราบถึงคุณค่าของ ความคิดเห็นที่เป็นประโยชน์ โค้ดที่แสดงความคิดเห็นช่วยให้โค้ดที่โอนจากสมาชิกทีมหนึ่งไปยังอีกทีมหนึ่งได้ง่ายขึ้น ความคิดเห็นช่วยให้ทีม QA ทดสอบรหัสเนื่องจากสามารถบอกได้ว่านักพัฒนาซอฟต์แวร์ต้องการอะไร - แม้ว่าจะไม่ประสบความสำเร็จก็ตาม แต่ด้วยความนิยมของแพลตฟอร์มการเขียนเว็บไซต์เช่น Wordpress ซึ่งช่วยให้คุณสามารถเริ่มต้นและใช้งานชุดรูปแบบที่เลือกซึ่งจัดการกับ HTML สำหรับคุณได้เป็นอย่างดีไม่ควรใช้ความคิดเห็นบ่อยๆโดยทีมงานเว็บ เนื่องจากความคิดเห็นเป็นเรื่องยากที่จะเห็นในเครื่องมือการเขียนภาพส่วนใหญ่ถ้าคุณไม่ได้ทำงานโดยตรงกับโค้ด ตัวอย่างเช่นแทนที่จะเห็นที่ด้านบนของหน้าเว็บ:
เครื่องมือภาพจะแสดงไอคอนเล็ก ๆ เพื่อระบุว่ามีความคิดเห็นอยู่ หากนักออกแบบไม่สามารถเปิดความคิดเห็นได้ร่างกายเขาอาจไม่เคยเห็น และในกรณีของหน้าข้างต้นอาจทำให้เกิดปัญหาหากเธอแก้ไขหน้าและการแก้ไขนั้นเกินเขียนโดยสคริปต์ที่กล่าวถึงในความคิดเห็น
สิ่งที่สามารถทำได้?
- เขียนความคิดเห็นที่มีความหมายและเป็นประโยชน์ อย่าหวังว่าคนอื่นจะอ่านความคิดเห็นของคุณหากพวกเขายาวเกินไปหรือไม่รวมข้อมูลที่เป็นประโยชน์
- ในฐานะผู้พัฒนาคุณควรตรวจสอบความคิดเห็นที่คุณเห็นในหน้าเสมอ
- ใช้เครื่องมือที่มาจากโปรแกรมการเขียนที่อนุญาตให้คุณเพิ่มความคิดเห็น
- ใช้การจัดการเนื้อหาเพื่อควบคุมวิธีแก้ไขหน้า
แม้ว่าคุณจะเป็นคนเดียวที่แก้ไขหน้าเว็บของคุณ แต่ความคิดเห็นก็มีประโยชน์ หากคุณเพียงแก้ไขหน้าเว็บที่ซับซ้อนปีละครั้งคุณก็ลืมได้ง่ายๆว่าคุณสร้างตารางหรือรวบรวม CSS ไว้อย่างไร ด้วยความคิดเห็นคุณไม่จำเป็นต้องจดจำตามที่เขียนไว้สำหรับคุณ
บทความต้นฉบับโดย Jennifer Krynin แก้ไขโดย Jeremy Girard เมื่อวันที่ 5/5/17