Trong tài liệu HTML, bạn có thể viết chú thích không được dịch bởi trình duyệt web. Mục đích dùng chú thích trong file HTML là ghi chép ngắn gọn (giải thích) mã, cho chính bạn hoặc thành viên nhóm.
Để thêm chú thích trong tài liệu HTML, chúng ta dùng thẻ mở và đóng chú thích: <!-- --> với văn bản bên trong, như sau:
<!-- Đây là chú thích trên một dòng -->Chú thích HTML cũng có thể trên nhiều dòng:
<!-- Đây là chú thích. Đây là chú thích khác. -->Lưu ý: khi tôi nói chú thích HTML không được dịch bởi trình duyệt, tôi muốn nói chú thích sẽ không hiển thị cho người truy cập trừ khi họ chuột phải trang và chọn Xem nguồn trang (View Page Source). Đây cũng là lý do bạn không bao giờ nên viết thông tin nhạy cảm trong chú thích, như mật khẩu.
Viết chú thích trong mã HTML có phải thói quen tốt không?
Tùy người bạn hỏi. Một số nhà phát triển thề không dùng chú thích trong file mã, nói chung, gợi ý mã nên tường minh và tự giải thích. Tôi không mua điều đó, vì nhà phát triển có ý kiến khác nhau về gì tường minh và gì ngầm hiểu.
Tôi thiên về làm mọi thứ rõ ràng nhất có thể. Tôi thích giải thích hơi nhiều hơn là quá ít. Đặc biệt người mới bắt đầu hưởng lợi từ sự nắm tay thêm ở đầu quá trình học.
Chú thích vs Tải trang (Hiệu suất)
Nhược điểm chính của chú thích trong tài liệu HTML là nó chiếm chút không gian, làm tăng kích thước build và do đó ảnh hưởng tải trang. Tuy nhiên, đây chỉ là vấn đề lý thuyết. Không lần nào tôi nghe nói trang web có tăng hiệu suất đáng kể bằng cách loại bỏ chú thích. Chú thích chiếm rất ít không gian tương đối, stress về nó hơi ngớ ngẩn.
100 dòng chú thích HTML chiếm khoảng 1KB — nhưng chưa gzip (phép nén) sẽ làm nhỏ hơn đáng kể.
Chú thích nên ngắn gọn và súc tích. Vì vậy trừ khi bạn định viết tiểu thuyết tiếp theo trong chú thích HTML, đừng lo.
Thay vào đó, bạn nên lo về cải thiện nén file hình ảnh trên trang. Dùng phương pháp nén tốt hơn trên chỉ một hình ảnh trên trang có thể cải thiện tải trang nhiều hơn loại bỏ hàng ngàn dòng chú thích HTML. Chỉ để cho thấy sự tương đối.