Nhận xét đơn và nhiều dòng được sử dụng trong javascript như thế nào?

Sử dụng nhận xét giúp hiểu mã và mục đích của nó. Tuy nhiên, nhiều developer chưa ý thức được việc sử dụng comment đúng cách, đôi khi làm phức tạp hóa mọi thứ lên.

Vì vậy, trong bài viết này, tôi sẽ thảo luận về thời điểm bạn nên sử dụng nhận xét và các phương pháp hay nhất mà bạn cần tuân theo

Có 2 cú pháp bình luận trong JavaScript

Mỗi ngôn ngữ lập trình có bộ cú pháp riêng khi nói đến nhận xét. Trong JavaScript, có hai cú pháp dành riêng cho nhận xét. Vì vậy, trước khi đi vào chi tiết, hãy lướt nhanh qua hai cú pháp này

1. Nhận xét một dòng

Trong JavaScript, nhận xét một dòng bắt đầu bằng

let p= 3.14; // The value of Pi (π)
let a = 2 * p * 10 // Circumference of circle with radius 10

0. Nó sẽ bỏ qua tất cả những thứ ngay sau cú pháp

let p= 3.14; // The value of Pi (π)
let a = 2 * p * 10 // Circumference of circle with radius 10

0 cho đến khi kết thúc dòng đó

// Single line

Điều này còn được gọi là nhận xét nội tuyến khi chúng tôi sử dụng cú pháp

let p= 3.14; // The value of Pi (π)
let a = 2 * p * 10 // Circumference of circle with radius 10

0 bên cạnh các dòng mã. Đây là hình thức bình luận chính xác nhất vì nó chỉ liên quan đến dòng mã cụ thể mà nó được viết trên đó.

let p= 3.14; // The value of Pi (π)
let a = 2 * p * 10 // Circumference of circle with radius 10

2. Nhận xét nhiều dòng

Nhận xét nhiều dòng hoặc khối phục vụ cùng một mục đích và như tên gợi ý, nó mở rộng thành nhiều dòng

Thông thường, hầu hết các nhà phát triển sử dụng cú pháp

let p= 3.14; // The value of Pi (π)
let a = 2 * p * 10 // Circumference of circle with radius 10

3 và

let p= 3.14; // The value of Pi (π)
let a = 2 * p * 10 // Circumference of circle with radius 10

4 để viết nhận xét khối nhiều dòng. Nhưng cách tiêu chuẩn để sử dụng khối nhận xét trong JavaScript là;

1. Bắt đầu với

   let p= 3.14; // The value of Pi (π)
   let a = 2 * p * 10 // Circumference of circle with radius 10

   5 trong một dòng trống
2. Kết thúc bằng

   let p= 3.14; // The value of Pi (π)
   let a = 2 * p * 10 // Circumference of circle with radius 10

   4 ở cuối dòng
3. Sử dụng

   let p= 3.14; // The value of Pi (π)
   let a = 2 * p * 10 // Circumference of circle with radius 10

   7 ở đầu mỗi dòng giữa bắt đầu và kết thúc

let p= 3.14; // The value of Pi (π)
let a = 2 * p * 10 // Circumference of circle with radius 10

0

Khi nào bạn nên sử dụng nhận xét trong JavaScript?

Như tôi đã đề cập, hầu hết thời gian, các nhà phát triển sử dụng nhận xét để giải thích mã. Nhưng còn nhiều điều hơn thế nữa

1. lời nói đầu

Mở đầu hoặc giải thích mã là một trong những mục tiêu chính của việc sử dụng nhận xét. Nó không chỉ dành cho các nhà phát triển khác;

Bạn có thể sử dụng nhận xét nội tuyến hoặc sử dụng nhận xét khối kèm theo giải thích ngắn gọn về việc sử dụng nhận xét đó

let p= 3.14; // The value of Pi (π)
let a = 2 * p * 10 // Circumference of circle with radius 10

1

2. Để gỡ lỗi

Vì công cụ JavaScript không diễn giải các mã được nhận xét, nên chúng tôi có thể sử dụng các nhận xét cho mục đích gỡ lỗi

Ví dụ: nếu có lỗi trong mã của bạn, bạn có thể nhận xét các dòng mã và chạy lại mã để xem dòng nào tôi đang gây ra lỗi

3. gắn thẻ

Sử dụng Thẻ JSDocs là một phương pháp hay khác mà các nhóm phát triển có thể làm theo để thể hiện ý tưởng của họ về mã cho các thành viên trong nhóm

Thẻ thêm cấu trúc ngữ nghĩa cho nhận xét của bạn. Điều đó cho phép các công cụ phát triển sử dụng dữ liệu này để phân tích thông minh

let p= 3.14; // The value of Pi (π)
let a = 2 * p * 10 // Circumference of circle with radius 10

2

Tương tự như vậy, bạn có thể sử dụng nhiều tùy chọn gắn thẻ và các thẻ này đưa ra dấu hiệu rõ ràng cho các nhà phát triển khác ghé thăm công việc của bạn

Ví dụ, Bit sử dụng các thẻ JSDocs để tạo bảng thuộc tính cho các thành phần

Xem thành phần nút trên Bit Cloud

4. Lưu trữ siêu dữ liệu

Lưu trữ siêu dữ liệu của tệp là một cách sử dụng bình luận phổ biến khác. Ví dụ: chúng tôi có thể bao gồm thông tin tác giả, phiên bản, liên kết repo trong siêu dữ liệu và chúng trở nên hữu ích trong các ứng dụng nguồn mở

let p= 3.14; // The value of Pi (π)
let a = 2 * p * 10 // Circumference of circle with radius 10

3

Ghi chú. Những tập quán này không được xác định hoặc cố định. Các nhà phát triển có thể có cách thực hành của riêng họ và tôi đã trình bày một số tình huống được sử dụng nhiều nhất

Thực hành tốt nhất để làm theo khi sử dụng bình luận

Không có quy tắc được xác định trước để sử dụng nhận xét. Tuy nhiên, với tư cách là một cá nhân hoặc một nhóm, điều cần thiết là phải đồng ý với một số phương pháp hay nhất xung quanh nhận xét để có sự thống nhất

1. Mã cho biết `làm thế nào` và nhận xét cho biết `tại sao`

Nhận xét phải sâu sắc đối với người đọc chúng và chúng ta nên luôn tránh viết mã hoạt động như thế nào trong nhận xét. Ở đây, mã sẽ có thể tự giải thích cách thức hoạt động của nó, giữ các nhận xét để giải quyết lý do tại sao nó lại ở đó ngay từ đầu

let p= 3.14; // The value of Pi (π)
let a = 2 * p * 10 // Circumference of circle with radius 10

4

2. Chỉ sử dụng mức độ chi tiết cần thiết

Sử dụng bình luận là tốt. Tuy nhiên, bạn không nên lạm dụng nó bằng cách mô tả mã ngoài những gì được yêu cầu. Thách thức ở đây là bạn cũng cần duy trì nhận xét và sửa đổi chúng. Bên cạnh đó, nó có thể ảnh hưởng tiêu cực đến khả năng đọc mã

let p= 3.14; // The value of Pi (π)
let a = 2 * p * 10 // Circumference of circle with radius 10

5

3. Tránh viết tắt

Chúng ta không nên sử dụng các từ viết tắt như

let p= 3.14; // The value of Pi (π)
let a = 2 * p * 10 // Circumference of circle with radius 10

8 vì không phải ai cũng hiểu chúng. Mặc dù họ làm cho câu của bạn ngắn gọn, nhưng nó bất chấp mục đích truyền tải thông điệp rõ ràng đến người đọc

let p= 3.14; // The value of Pi (π)
let a = 2 * p * 10 // Circumference of circle with radius 10

7

4. Sử dụng nhận xét trước mã

Mục đích chính của việc viết bình luận là để cho người đọc biết những gì họ có thể mong đợi từ mã của chúng tôi. Vì vậy, họ sẽ đọc các bình luận và hiểu những gì đang diễn ra trước khi xem qua mã

Vì vậy, tốt hơn hết là sử dụng các nhận xét phía trên mã bạn giải thích và nó sẽ tiết kiệm rất nhiều thời gian cho người đọc

let p= 3.14; // The value of Pi (π)
let a = 2 * p * 10 // Circumference of circle with radius 10

8

5. Chú ý nhiều hơn đến các giá trị số

Xử lý các giá trị số luôn có thể phức tạp vì có các phạm vi và đơn vị cụ thể được sử dụng. Ở đây, chúng ta có thể sử dụng nhận xét để giải thích các đơn vị được sử dụng và phạm vi của chúng. Ngoài ra, nếu có bất kỳ hạn chế nào đối với dữ liệu đầu vào, chúng tôi có thể đề cập đến chúng trong nhận xét của mình

6. Hỗ trợ biên tập viên

Tất cả các trình soạn thảo mã hiện đại đều cung cấp hỗ trợ của họ đối với việc sử dụng nhận xét. Vì vậy, chúng ta cần tận dụng tối đa

Ví dụ: bạn có thể sử dụng

let p= 3.14; // The value of Pi (π)
let a = 2 * p * 10 // Circumference of circle with radius 10

9 để nhận xét một dòng mã hoặc một khối mã trong bất kỳ trình chỉnh sửa nào. Ngoài ra, chúng tự động hoàn thành cú pháp mã khối khi bạn gõ cú pháp mở đầu (

let p= 3.14; // The value of Pi (π)
let a = 2 * p * 10 // Circumference of circle with radius 10

5)

Bên cạnh đó, có các plugin như Nhận xét tốt hơn có sẵn cho VSCode. Các tiện ích mở rộng này giúp tạo các nhận xét dễ đọc hơn như bên dưới

Phần kết luận

Trong bài viết này, tôi đã thảo luận về một số trường hợp sử dụng nhận xét trong JavaScript và các phương pháp hay nhất mà chúng ta cần tuân theo

Là nhà phát triển, chúng ta phải luôn tuân thủ các phương pháp hay nhất đó vì nó sẽ tăng khả năng đọc và giúp bạn và nhóm của bạn hiểu mã của bạn dễ dàng hơn

Tôi hy vọng những đề xuất đó sẽ giúp bạn cải thiện khả năng đọc mã của mình và nếu bạn có bất kỳ đề xuất nào, vui lòng chia sẻ chúng với những người khác trong phần nhận xét

Cảm ơn bạn đã đọc

Xây dựng Component Libs và Hệ thống thiết kế tốt hơn

Chia sẻ các thành phần giữa các nhóm và dự án để tăng tốc độ phát triển và đảm bảo người dùng của bạn trải nghiệm một thiết kế nhất quán ở mọi điểm tiếp xúc

Các công cụ OSS như Bit cung cấp trải nghiệm nhà phát triển tuyệt vời để xây dựng, chia sẻ và áp dụng các thành phần giữa các nhóm và ứng dụng. Hãy dùng thử miễn phí một trung tâm thành phần →

Nhận xét một dòng và nhiều dòng trong JavaScript là gì?

Các bình luận đơn lẻ được viết bằng JavaScript như thế nào?

Hai hình thức nhận xét JavaScript là gì?

Mục đích của việc đưa ra nhận xét giải thích nhận xét một dòng và nhiều dòng là gì?