Nhận xét HTML là gì và chúng được sử dụng như thế nào
aKhi bạn xem một trang web trong trình duyệt, bạn sẽ thấy một biểu thị trực quan về phần của phần mềm (trình duyệt web) hiển thị dựa trên mã của một trang web cụ thể. Nếu bạn xem mã nguồn của trang web đó, bạn sẽ thấy một tài liệu được tạo thành từ nhiều phần tử HTML khác nhau, bao gồm các đoạn văn, tiêu đề, danh sách, liên kết, hình ảnh và hơn thế nữa. Tất cả các yếu tố này được trình duyệt hiển thị trên màn hình của khách truy cập như là một phần của việc hiển thị trang web. Một điều bạn có thể tìm thấy trong mã HTML không được hiển thị trên màn hình của một người là những gì được gọi là "nhận xét HTML".
Bình luận là gì?
Nhận xét là một chuỗi mã trong HTML, XML hoặc CSS không được trình duyệt hoặc trình phân tích cú pháp xem hoặc hành động. Nó chỉ đơn giản là được viết vào mã để cung cấp thông tin về mã đó hoặc các phản hồi khác từ các nhà phát triển mã.
Hầu hết các ngôn ngữ lập trình đều có nhận xét, chúng thường được nhà phát triển mã sử dụng cho một hoặc thậm chí nhiều hơn một lý do sau:
- Mô tả và giải thích mã phức tạp cho người có thể phải làm việc với nó trong tương lai - kể cả bản thân họ! Họ có thể quay trở lại mã 3 hoặc 6 của 12 tháng hoặc hơn sau đó và không nhớ tại sao họ đã làm một cái gì đó một cách nhất định. Nhận xét có thể giúp trả lời các câu hỏi của họ và nhắc nhở họ về vị trí của họ khi họ lần đầu tiên phát triển trang đó.
- Cung cấp chi tiết về thời điểm mã được chỉnh sửa hoặc xem xét. Đây có thể là thông tin hữu ích và hoạt động giống như nhật ký phát triển khi trang web được thực hiện lần cuối.
- Xóa các phần của mã, nhưng để chúng có sẵn để sử dụng sau này. Điều này thường được thực hiện trong khi thử nghiệm và gỡ lỗi trang web. Nếu bạn gặp sự cố trên trang web và không chắc chắn điều gì đang gây ra, bạn có thể nhận xét từng phần một để quarentine và xác định vấn đề, sau đó khắc phục sự cố cho bất kỳ vấn đề nào bạn gặp phải.
- Trò chuyện với các nhà phát triển khác làm việc trên mã. Điều này có thể sẽ được thực hiện trong quá trình phát triển như một cách để chia sẻ chi tiết với những người khác làm việc trên mã cùng một lúc. Nếu những nhận xét này hoàn toàn là các cuộc hội thoại phát triển, cách tốt nhất là xóa chúng khỏi mã trước khi một trang web được khởi chạy.
Theo truyền thống, các nhận xét trong HTML được sử dụng cho hầu hết các phần tử, từ các giải thích về cấu trúc bảng phức tạp đến các nhận xét thông tin về nội dung của trang đó. Vì nhận xét không được hiển thị trong trình duyệt, bạn có thể thêm chúng vào bất kỳ đâu trong HTML và không phải lo lắng về những gì nó sẽ làm khi trang web được khách hàng xem.
Cách viết nhận xét
Viết nhận xét bằng HTML, XHTML và XML rất dễ dàng. Chỉ cần bao quanh văn bản bạn muốn nhận xét với những điều sau:
và ->Như bạn có thể thấy, các nhận xét này bắt đầu bằng "ít hơn biểu tượng", cộng với điểm tuyên bố và hai dấu gạch ngang. Nhận xét kết thúc bằng hai dấu gạch ngang và một biểu tượng "lớn hơn:. Giữa các ký tự đó bạn có thể viết bất cứ điều gì bạn muốn tạo nên phần thân của chú thích.
Trong CSS, có một chút khác biệt, bằng cách sử dụng các bình luận mã C thay vì HTML Bạn bắt đầu với một dấu gạch chéo về phía trước theo dấu hoa thị. Bạn kết thúc bình luận với nghịch đảo của điều đó, một dấu hoa thị theo sau là một dấu gạch chéo về phía trước.
/ * văn bản nhận xét * /Nhận xét là Nghệ thuật sắp chết
Hầu hết các lập trình viên đều biết giá trị của các bình luận hữu ích . Mã nhận xét giúp việc chuyển mã từ thành viên này sang nhóm khác dễ dàng hơn. Nhận xét giúp nhóm QA của bạn kiểm tra mã, vì họ có thể biết nhà phát triển dự định gì - ngay cả khi nó không đạt được. Thật không may, với sự phổ biến của các nền tảng soạn thảo trang web như Wordpress, cho phép bạn bắt đầu và chạy với một chủ đề được chọn xử lý nhiều, nếu không phải tất cả, của HTML cho bạn, các nhận xét không được các nhóm web sử dụng thường xuyên. Điều này là do các nhận xét thực sự khó thấy trong hầu hết các công cụ tạo tác động trực quan nếu bạn không làm việc trực tiếp với mã. Ví dụ: thay vì nhìn thấy, ở đầu trang web:
Công cụ trực quan hiển thị biểu tượng nhỏ để cho biết rằng nhận xét có ở đó. Nếu nhà thiết kế không mở được bình luận, anh ta sẽ không bao giờ nhìn thấy nó. Và trong trường hợp của trang ở trên, có thể gây ra sự cố nếu cô ấy chỉnh sửa trang và việc chỉnh sửa đó được viết đè lên bởi tập lệnh được đề cập trong nhận xét.
Những gì có thể được thực hiện?
- Viết ý kiến hữu ích và ý nghĩa. Đừng mong đợi người khác đọc nhận xét của bạn nếu họ quá dài hoặc không bao gồm thông tin hữu ích.
- Là một nhà phát triển, bạn nên luôn xem lại bất kỳ nhận xét nào bạn thấy trên trang.
- Sử dụng các công cụ được cung cấp bởi các chương trình tác giả cho phép bạn thêm nhận xét.
- Sử dụng quản lý nội dung để kiểm soát cách các trang được chỉnh sửa.
Ngay cả khi bạn là người duy nhất chỉnh sửa trang web của bạn, nhận xét có thể hữu ích. Nếu bạn chỉ chỉnh sửa một trang phức tạp mỗi năm một lần, thật dễ dàng để quên cách bạn xây dựng bảng hoặc gộp lại CSS. Với ý kiến, bạn không cần phải nhớ, vì nó được viết ngay tại đó cho bạn.
Bài báo gốc của Jennifer Krynin. Biên tập bởi Jeremy Girard vào ngày 5/5/17