Cách thêm nhận xét vào HTML của bạn

Nhận xét HTML đánh dấu đúng là một phần quan trọng của một trang web được xây dựng tốt. Những nhận xét đó dễ dàng thêm vào và bất kỳ ai phải làm việc trên mã của trang web đó trong tương lai (bao gồm cả chính bạn hoặc thành viên của bất kỳ nhóm nào bạn làm việc cùng) sẽ cảm ơn bạn vì những nhận xét đó.

Cách thêm nhận xét HTML

HTML có thể được viết với một trình soạn thảo văn bản chuẩn, như Notepad ++ cho Windows hoặc TextEdit cho Ma. Bạn cũng có thể sử dụng một chương trình thiết kế tập trung vào web như Adobe Dreamweaver hoặc thậm chí một nền tảng CMS như Wordpress hoặc ExpressionEngine. Bất kể công cụ mà bạn sử dụng để viết HTML, nếu bạn đang làm việc trực tiếp với mã, bạn sẽ thêm các nhận xét HTML như sau:

  1. Thêm phần đầu tiên của thẻ nhận xét HTML:
  2. Sau phần mở đầu của nhận xét, hãy viết bất kỳ văn bản nào bạn muốn xuất hiện cho nhận xét này. Đây có thể là hướng dẫn cho nhà phát triển của bạn hoặc một nhà phát triển khác trong tương lai. Ví dụ: nếu bạn muốn chỉ định nơi một phần nhất định trên trang bắt đầu hoặc kết thúc trong đánh dấu, bạn có thể sử dụng nhận xét để chi tiết điều đó.
  3. Khi văn bản của nhận xét của bạn hoàn tất, hãy đóng thẻ nhận xét như sau: ->
  4. Vì vậy, tổng cộng, nhận xét của bạn sẽ trông giống như sau:

Hiển thị nhận xét

Bất kỳ nhận xét nào bạn thêm vào mã HTML sẽ xuất hiện trong mã đó khi ai đó xem nguồn của trang web hoặc mở HTML trong trình chỉnh sửa để thực hiện một số thay đổi. Tuy nhiên, văn bản nhận xét đó sẽ không xuất hiện trong trình duyệt web khi một khách truy cập bình thường đến trang web. Không giống như các phần tử HTML khác, bao gồm các đoạn văn, tiêu đề hoặc danh sách thực sự tác động đến trang bên trong các trình duyệt đó, các nhận xét thực sự là "hậu trường" của trang.

Bình luận cho mục đích thử nghiệm

Vì nhận xét không xuất hiện trong trình duyệt web, chúng có thể được sử dụng để "tắt" các phần của trang trong khi thử nghiệm hoặc phát triển trang. Nếu bạn thêm phần mở của nhận xét ngay trước phần trang / mã mà bạn muốn ẩn, sau đó bạn thêm phần đóng ở cuối mã đó (các nhận xét HTML có thể mở rộng nhiều dòng, vì vậy bạn có thể mở nhận xét về dòng 50 của mã của bạn và đóng nó trên dòng 75 không có vấn đề gì), thì bất kỳ phần tử HTML nào nằm trong nhận xét đó sẽ không còn được hiển thị trong trình duyệt nữa. Chúng sẽ vẫn còn trong mã của bạn, nhưng sẽ không ảnh hưởng đến hiển thị trực quan của trang. Nếu bạn cần kiểm tra một trang để xem một phần nào đó có gây ra sự cố hay không, v.v., hãy nhận xét rằng khu vực đó là thích hợp hơn để xóa nó. Với nhận xét, nếu phần mã được đề cập không phải là vấn đề, bạn có thể dễ dàng xóa các phần nhận xét và mã đó sẽ được hiển thị lại một lần nữa. Chỉ cần chắc chắn rằng những nhận xét được sử dụng để thử nghiệm không đưa nó vào trang web sản xuất.

Nếu một khu vực của một trang không được hiển thị, bạn muốn xóa mã, chứ không phải chỉ nhận xét nó ra, trước khi bạn khởi chạy trang đó.

Một cách sử dụng tuyệt vời các nhận xét HTML trong quá trình phát triển là khi bạn xây dựng trang web đáp ứng . Do các phần khác nhau của trang web đó sẽ thay đổi diện mạo của chúng dựa trên các kích thước màn hình khác nhau , bao gồm một số khu vực có thể không được hiển thị, sử dụng nhận xét để chuyển đổi các phần của trang hoặc tắt có thể là một mẹo nhanh chóng và dễ sử dụng trong quá trình phát triển.

Về hiệu suất

Tôi đã thấy một số chuyên gia web đề xuất rằng các nhận xét nên bị loại bỏ khỏi các tệp HTML và CSS để tiết kiệm kích thước của các tệp đó và tạo các trang tải nhanh hơn. Mặc dù tôi đồng ý rằng các trang phải được tối ưu hóa cho hiệu suất và phải tải nhanh, vẫn còn một nơi để sử dụng thông minh các nhận xét trong mã. Hãy nhớ rằng, các nhận xét này có nghĩa là làm cho việc làm việc trên trang web trở nên dễ dàng hơn trong tương lai, miễn là bạn không quá hạn với các nhận xét được thêm vào mỗi dòng trong mã của bạn, số lượng tệp nhỏ được thêm vào một trang do bình luận nên nhiều hơn chấp nhận được.

Mẹo sử dụng nhận xét

Một vài điều cần lưu ý hoặc nhớ khi sử dụng nhận xét HTML:

  1. Nhận xét có thể là nhiều dòng.
  2. Sử dụng nhận xét để ghi lại sự phát triển của trang của bạn.
  3. Bình luận có thể al; vì vậy nội dung tài liệu, hàng hoặc cột của bảng, theo dõi thay đổi hoặc bất cứ điều gì bạn muốn.
  4. Bình luận rằng "tắt" các khu vực của một trang web không nên làm cho nó vào sản xuất trừ khi thay đổi này là một tạm thời sẽ được đảo ngược theo thứ tự ngắn (như có một thông điệp cảnh báo bật hoặc tắt khi cần thiết).