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

วิธีแสดงความคิดเห็นโค้ด HTML

ในเอกสาร HTML คุณสามารถเขียนความคิดเห็นที่ไม่ได้ตีความโดยเว็บเบราว์เซอร์ จุดประสงค์ของการใช้ความคิดเห็นในไฟล์ HTML ของคุณคือเพื่อจัดทำเอกสาร (อธิบาย) โค้ดสั้นๆ ไม่ว่าจะเป็นสำหรับตัวคุณเองหรือสำหรับสมาชิกในทีมของคุณ

ในการเพิ่มความคิดเห็นในเอกสาร HTML เราใช้แท็กความคิดเห็นเปิดและปิด:<!-- --> โดยมีข้อความอยู่ข้างใน ดังนี้

<!-- Here is a comment on a single line -->

ความคิดเห็น HTML สามารถอยู่ในหลายบรรทัด:

<!-- 
Here is a comment.
Here is another comment.
-->

หมายเหตุ:เมื่อฉันบอกว่าความคิดเห็น HTML ไม่ได้ ตีความ โดยเว็บเบราว์เซอร์ ฉันหมายความว่าผู้เยี่ยมชมเว็บไซต์จะไม่เห็นความคิดเห็น เว้นแต่พวกเขาจะคลิกขวาบนหน้าแล้วคลิกดูแหล่งที่มาของหน้า นี่คือเหตุผลที่คุณไม่ควรเขียน ละเอียดอ่อน ข้อมูลในความคิดเห็นของคุณ เช่น รหัสผ่าน

การเขียนความคิดเห็นในโค้ด HTML ของคุณเป็นวิธีที่ดีหรือไม่ ?

ขึ้นอยู่กับว่าคุณถามใคร นักพัฒนาซอฟต์แวร์บางคนสาบานว่าจะไม่ใช้ความคิดเห็นในไฟล์โค้ด โดยทั่วไป โดยเสนอแนะว่าโค้ดของคุณควรมีความชัดเจนและอธิบายตนเองได้ ฉันไม่ซื้อสิ่งนั้นเพราะนักพัฒนามีความคิดเห็นที่แตกต่างกันเกี่ยวกับสิ่งที่ชัดเจนและโดยนัย

ฉันทำผิดพลาดในการทำให้สิ่งต่าง ๆ ชัดเจนที่สุด ฉันอยากจะอธิบายให้มากไปหน่อย ดีกว่าอธิบายให้น้อยเกินไป โดยเฉพาะผู้เริ่มต้นจะได้รับประโยชน์จากการจับมือกันเป็นพิเศษในช่วงเริ่มต้นของกระบวนการเรียนรู้

ความคิดเห็นกับการโหลดหน้าเว็บ (ประสิทธิภาพ)

ข้อเสียหลักของความคิดเห็นในเอกสาร HTML ของคุณคือมันใช้พื้นที่บางส่วน ซึ่งเพิ่มขนาดให้กับงานสร้างของคุณและส่งผลต่อการโหลดหน้า อย่างไรก็ตาม นี่เป็นเพียงปัญหาเชิงทฤษฎีเท่านั้น ฉันไม่เคยได้ยินเกี่ยวกับเว็บไซต์ที่ได้รับการเพิ่มประสิทธิภาพอย่างมากโดยการตัดความคิดเห็นออก ความคิดเห็นใช้พื้นที่เพียงเล็กน้อย ซึ่งทำให้เครียดได้เล็กน้อย

ความคิดเห็น HTML 100 บรรทัดใช้พื้นที่ประมาณ 1KB — แต่ไม่มี gzipping (วิธีการบีบอัด) ซึ่งจะทำให้น้อยลงอย่างมาก

ความคิดเห็นควรสั้นและตรงประเด็น ดังนั้น ถ้าคุณไม่คิดจะเขียนนวนิยายเรื่องถัดไปในความคิดเห็น HTML ก็ไม่ต้องกังวลไป

คุณควรกังวลเกี่ยวกับการปรับปรุงการบีบอัดไฟล์รูปภาพในไซต์ของคุณแทน การใช้วิธีบีบอัดรูปภาพเพียงภาพเดียวบนเว็บไซต์ของคุณน่าจะช่วยปรับปรุงการโหลดหน้าเว็บของคุณมากกว่าการตัดความคิดเห็น HTML ออกเป็นพันๆ บรรทัด เพียงเพื่อให้สิ่งต่าง ๆ ในมุมมอง