Làm thế nào để bình luận trong HTML?

Để viết bình luận HTML, đặt ở hai đầu của bình luận. Nhận xét HTML là ghi chú để giữ cho mã HTML được sắp xếp và bị trình duyệt bỏ qua


Một trong những khía cạnh quan trọng nhất của phần mềm ghi tài liệu là viết nhận xét về mã của bạn. Nhận xét là các dòng tồn tại trong các chương trình máy tính bị trình thông dịch và trình biên dịch bỏ qua và được con người đọc

Làm thế nào để bình luận trong HTML?
Làm thế nào để bình luận trong HTML?

Tìm trận đấu Bootcamp của bạn

  • Career Karma kết hợp bạn với các bootcamp công nghệ hàng đầu
  • Truy cập học bổng độc quyền và các khóa học chuẩn bị
Chọn sở thích của bạn
Tên đầu tiên

Họ

E-mail

Số điện thoại


Bằng cách tiếp tục, bạn đồng ý với Điều khoản dịch vụ và Chính sách quyền riêng tư của chúng tôi và bạn đồng ý nhận các ưu đãi và cơ hội từ Career Karma qua điện thoại, tin nhắn văn bản và email

Viết nhận xét cho phép bạn làm cho mã của mình dễ đọc hơn và giải thích những phần cụ thể của chương trình đang thực hiện. Ví dụ: nếu bạn đang viết một chương trình dài, bạn có thể sử dụng nhận xét để theo dõi các chức năng hoặc dòng mã nhất định

Trong hướng dẫn này, chúng ta sẽ khám phá cách viết bình luận trong HTML. Chúng ta sẽ bắt đầu bằng cách xem xét lý do tại sao bình luận được sử dụng trong lập trình. Sau đó, chúng ta sẽ xem xét hai loại nhận xét chính. chú thích một dòng và nhiều dòng

Tại sao các nhà phát triển viết bình luận?

Trong HTML, các nhận xét bị trình duyệt bỏ qua và bị xóa khi mã được biên dịch và rút gọn. Vì vậy, tại sao chúng ta viết bình luận?

Nhận xét được viết để con người đọc và hỗ trợ làm cho mã dễ hiểu hơn. Khi bạn đang làm việc trên một dự án một mình, bạn rất dễ bỏ qua các nhận xét vì bạn là người duy nhất đọc mã của mình. Tuy nhiên, nếu bạn đang làm việc trong một dự án lớn bao gồm mã phức tạp, thì bạn có thể dễ dàng mất mục đích mã của mình

Ngoài ra, nếu bạn đang làm việc theo nhóm, những người khác có thể không hiểu mã bạn đã viết. Nếu trường hợp này xảy ra, mọi người có thể phải theo dõi bạn để tìm ra mục đích của đoạn mã cụ thể hoặc có thể bỏ qua một dòng mã mà không hiểu ý nghĩa và cách thức hoạt động của nó

» THÊM.   4 mẹo mã hóa thuộc tính màu HTML của bạn

Nhận xét mang lại một số lợi ích cho nhà phát triển. Thứ nhất, như chúng ta đã thảo luận, nhận xét làm cho mã của bạn dễ hiểu hơn. Nếu bạn viết nhận xét về mã của mình, cả bạn và những người khác đọc mã của bạn sẽ dễ dàng theo dõi những gì đang diễn ra tại một số điểm nhất định trong mã

Thứ hai, các nhận xét cho phép các nhà phát triển giải thích lý do của họ đằng sau việc đưa ra quyết định về một chương trình. Điều này có thể hữu ích cả khi chương trình ngừng hoạt động và yêu cầu sửa lỗi hoặc khi nhà phát triển cần làm rõ thêm lý do tại sao một phương pháp nhất định được sử dụng để giải quyết vấn đề. Nhận xét cũng có thể giúp tăng tốc quá trình phát triển vì bạn dễ hiểu mã của mình hơn

Nhận xét HTML

Nhận xét trong tài liệu HTML được đặt trong các mũi tên đặc biệt và tách biệt với phần còn lại của chương trình. Nhận xét không được trình duyệt hiển thị. Đây là cú pháp cho một thẻ nhận xét HTML cơ bản

Khi trang web của chúng tôi được mở, mã này sẽ không xuất hiện trên trang web của chúng tôi. Thay vào đó, mã sẽ xuất hiện trong mã nguồn của chúng tôi để chúng tôi đọc

Ví dụ trên là một chú thích một dòng, có nghĩa là văn bản của nó sẽ chỉ xuất hiện trên một dòng. Loại bình luận này hữu ích nếu bình luận của bạn sẽ ngắn. Tuy nhiên, nếu bạn định viết một bình luận dài, bạn cần sử dụng bình luận nhiều dòng

Cú pháp cho chú thích nhiều dòng giống như chú thích một dòng, chỉ khác là chú thích đóng trên một dòng mới. Đây là cú pháp cho thẻ nhận xét nhiều dòng

Sử dụng Nhận xét HTML

Bây giờ bạn đã biết cách viết nhận xét trong HTML, bạn có thể tự hỏi. khi nào tôi nên thêm nhận xét vào mã của mình?

» THÊM.   Liên kết gửi thư HTML. Hướng dẫn từng bước

Nhận xét thường nên được sử dụng

  • Để mô tả kết quả dự định của mã
  • Để giải thích tại sao mã đã được viết
  • Để làm rõ một dòng hoặc dòng mã phức tạp

Tất nhiên, có những tình huống khác mà bạn có thể muốn thêm nhận xét vào mã của mình, nhưng đó là những tình huống phổ biến nhất

Ngoài ra, bạn cũng có thể muốn sử dụng nhận xét HTML để nhận xét các khối thẻ HTML. Điều này cho phép bạn giữ một dòng mã trong chương trình của mình nhưng hướng dẫn trình duyệt bỏ qua nó khi trang web HTML được hiển thị

Nhận xét mã ra khỏi chương trình của bạn là phổ biến trong quá trình gỡ lỗi. Điều này là do, trong quá trình gỡ lỗi, bạn cần tìm ra nguyên nhân của sự cố và triển khai giải pháp, đồng thời có thể hữu ích khi yêu cầu chương trình bỏ qua mã mà không xóa mã hoàn toàn khỏi chương trình của bạn. Đây là một ví dụ về việc sử dụng nhận xét HTML để nhận xét mã

This is an example paragraph.

Khi trình duyệt của chúng tôi hiển thị mã này, đoạn thứ hai sẽ bị bỏ qua vì nó được đính kèm trong các nhận xét

Nhận xét HTML, trong khi hữu ích, chỉ nên được sử dụng khi chúng sẽ thêm giá trị cho chương trình. Không cần thiết phải thêm nhận xét để giải thích mọi chức năng trong chương trình hoặc để giải thích các chủ đề có chiều sâu đáng kể. Dưới đây là một số mẹo bạn nên ghi nhớ khi viết bình luận HTML

  • Không trình bày lại mã hiện có. Nhận xét là để giải thích ý định của bạn hoặc logic của chương trình. Bạn không nên sử dụng nhận xét để nêu bằng tiếng Anh những gì đã được viết bằng mã
  • Đừng viết bình luận dài dòng. Các nhà phát triển thường muốn viết các bình luận dài để giải thích các thủ tục phức tạp. Tuy nhiên, trong khi các bình luận dài đôi khi hữu ích, bạn nên sử dụng chúng một cách tiết kiệm. Thay vào đó, nếu có một chức năng bạn cần giải thích sâu hơn, bạn có thể muốn tạo một mục nhập tài liệu
  • Đừng giải thích mọi thứ. Nhận xét được sử dụng để làm rõ một chương trình và có quá nhiều nhận xét có thể làm sao nhãng mã cốt lõi. Nếu một cái gì đó là rõ ràng, một bình luận là không cần thiết

» THÊM.   Dự án HTML hàng đầu giúp nâng cao kỹ năng và xây dựng danh mục đầu tư HTML của bạn

Phần kết luận

Sử dụng nhận xét HTML giúp làm cho chương trình của bạn dễ đọc hơn cho cả bạn và những người khác có thể đọc mã của bạn. Viết nhận xét xuyên suốt mã của bạn có thể giúp người khác hiểu ý định đằng sau mã của bạn dễ dàng hơn

Trong hướng dẫn này, chúng ta đã khám phá những kiến ​​thức cơ bản về nhận xét và cách tạo nhận xét trong HTML. Chúng tôi cũng đã thảo luận về lý do tại sao nhận xét lại hữu ích và phân tích một số phương pháp hay nhất để viết nhận xét hiệu quả. Điều đó nói rằng, mọi nhà phát triển đều có phong cách nhận xét của riêng họ và khi bạn viết nhiều nhận xét hơn, bạn sẽ thấy rằng bạn áp dụng phong cách của riêng mình

Bây giờ bạn đã biết cách viết bình luận trong HTML như một chuyên gia



Về chúng tôi. Career Karma là một nền tảng được thiết kế để giúp người tìm việc tìm kiếm, nghiên cứu và kết nối với các chương trình đào tạo việc làm để thăng tiến trong sự nghiệp của họ. Tìm hiểu về ấn phẩm CK