Computer >> Máy Tính >  >> Lập trình >> CSS

Cách nhận xét mã CSS

Cách sử dụng chú thích trong CSS.

Bạn viết nhận xét bên trong CSS stylesheet để ghi lại ngắn gọn (giải thích) mã, cho chính bạn hoặc cho các thành viên trong nhóm của bạn.

Để viết nhận xét trong CSS, chúng tôi sử dụng cú pháp / định dạng sau:

/* This is a CSS comment */

/* */ định dạng là duy nhất cách viết nhận xét trong CSS, do đó nó được sử dụng cho cả nhận xét đơn và nhiều dòng.

/* 
   This is a 
   multi-line 
   CSS comment.
   Also known as a block comment.
*/

Một vài ví dụ sử dụng cú pháp nhận xét để nhận xét ra Mã CSS bên trong bộ quy tắc:

  .box {
    background-color: #000;
    padding: 1.5rem;
    /* border-radius: 4px; */ 
  }
  .box {
    background-color: #000;
    padding: 1.5rem; /*
    border-radius: 4px; 
    box-shadow: 5px 10px #888888;
    */
  }

Trên thực tế, các nhận xét được sử dụng cả để lập tài liệu mã và đôi khi để nhận xét ra (hủy kích hoạt) một số khai báo kiểu nhất định trong khi thử nghiệm.

Đừng nhầm lẫn giữa nhận xét CSS với nhận xét JavaScript. Trong JavaScript /* */ (định dạng giống như CSS) được sử dụng cho nhiều dòng, trong khi nhận xét dòng đơn sử dụng dấu gạch chéo kép về phía trước // .

  • Nhận xét một dòng còn được gọi là inline bình luận.
  • Nhận xét nhiều dòng còn được gọi là khối nhận xét.

Bạn có thể đã thấy một số dự án mà họ đang sử dụng // cho các nhận xét một dòng trong mã CSS của họ. Nếu quan sát kỹ hơn một chút, bạn sẽ thấy rằng họ đang sử dụng Bộ tiền xử lý CSS, như Sass / SCSS hoặc Less, cho phép nhận xét một dòng - giống như JavaScript. Trong vani (thuần túy) CSS, rất tiếc là chúng tôi chỉ có /* */

Bạn có nên viết nhận xét trong mã CSS của mình không?

Giống như tôi đã giải thích trong hướng dẫn cách nhận xét HTML, các nhà phát triển không đồng ý về chủ đề này. Một số người tin rằng mã của bạn phải rõ ràng và dễ hiểu.

Đối với tôi, chủ đề không phải là trắng đen. Không phải tất cả các bình luận đều được viết như nhau. Bạn không nên sử dụng bảng định kiểu CSS để soạn thảo cuốn tiểu thuyết mới nhất của mình, nhưng những nhận xét nhỏ, ngắn gọn có thể tạo nên sự khác biệt giúp người mới bắt đầu hoặc người mới trong nhóm hiểu điều gì đang diễn ra trong mã của bạn.

Tôi sẽ coi rõ ràng quá ẩn ý bất kỳ ngày nào.

Đừng lo lắng về việc nhận xét của bạn chiếm quá nhiều dung lượng và làm ảnh hưởng đến quá trình tải trang của bạn. Nhận xét, hay văn bản, nói chung, là điều cuối cùng bạn nên lo lắng khi nói đến việc cải thiện hiệu suất / tốc độ tải trang. Bên cạnh đó, có những công cụ có thể xóa nhận xét trong quá trình xử lý hậu kỳ.