Có bao nhiêu loại bình luận javascript?

Nhận xét JavaScript là gợi ý mà lập trình viên có thể thêm vào để làm cho mã của họ dễ đọc và dễ hiểu hơn. Chúng hoàn toàn bị bỏ qua bởi các công cụ JavaScript

Có hai cách để thêm nhận xét vào mã

• // - Nhận xét một dòng
• /* */ -Nhận xét nhiều dòng

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

Trong JavaScript, bất kỳ dòng nào bắt đầu bằng // đều là một dòng nhận xét. Ví dụ,

name = "Jack";

// printing name on the console
console.log("Hello " + name);

Đây, // printing name on the console là một bình luận

Bạn cũng có thể sử dụng nhận xét một dòng như thế này

name = "Jack";

console.log("Hello " + name);  // printing name on the console

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

Trong Javascript, bất kỳ văn bản nào giữa /* và

name = "Jack";

console.log("Hello " + name);  // printing name on the console

/* The following program contains the source code for a game called Baghchal. 

Baghchal is a popular board game in Nepal where two players choose either sheep or tiger. It is played on a 5x5 grid.

For the player controlling the tiger to win, they must capture all the sheep. There are altogether 4 tigers on the board.

For the sheep to win, all tigers must be surrounded and cornered so that they cannot move. The player controlling the sheep has 20 sheep at his disposal.
*/

Vì phần còn lại của mã nguồn sẽ được sử dụng để triển khai các quy tắc của trò chơi, nhận xét ở trên là một ví dụ điển hình mà bạn có thể sử dụng nhận xét nhiều dòng

Sử dụng Nhận xét để gỡ lỗi

Nhận xét cũng có thể được sử dụng để vô hiệu hóa mã để ngăn không cho nó được thực thi. Ví dụ,

console.log("some code");
console.log("Error code);
console.log("other code");

Nếu bạn gặp lỗi trong khi chạy chương trình, thay vì xóa mã dễ bị lỗi, bạn có thể sử dụng nhận xét để vô hiệu hóa mã đó khỏi việc thực thi;

console.log("some code");
// console.log("Error code);
console.log("other code");

Mẹo chuyên nghiệp. Ghi nhớ lối tắt để sử dụng nhận xét; . Đối với hầu hết các trình soạn thảo mã, đó là

name = "Jack";

console.log("Hello " + name);  // printing name on the console

name = "Jack";

console.log("Hello " + name);  // printing name on the console

Làm cho mã dễ hiểu hơn

Là một nhà phát triển JavaScript, bạn sẽ không chỉ viết mã mà còn có thể phải sửa đổi mã do các nhà phát triển khác viết

Nếu bạn viết nhận xét về mã của mình, bạn sẽ dễ hiểu mã hơn trong tương lai. Ngoài ra, các nhà phát triển đồng nghiệp của bạn sẽ hiểu mã dễ dàng hơn

Theo nguyên tắc chung, hãy sử dụng các nhận xét để giải thích lý do tại sao bạn đã làm điều gì đó hơn là cách bạn đã làm điều gì đó và bạn đã làm tốt

Ghi chú. Nhận xét không nên thay thế cho cách giải thích mã được viết kém bằng tiếng Anh. Bạn phải luôn viết mã có cấu trúc tốt và dễ hiểu. Và, sau đó sử dụng ý kiến

Mục đích chính của việc viết mã là để máy tính có thể diễn giải nó thành các lệnh. Tuy nhiên, điều quan trọng là mã chúng tôi viết cũng dễ hiểu đối với các nhà phát triển đồng nghiệp

Bạn đã bao giờ quay lại một dự án và gặp khó khăn trong việc hiểu logic bên trong chưa?

Nhận xét là các ghi chú được viết bằng mã bị công cụ JavaScript bỏ qua, có nghĩa là chúng không ảnh hưởng đến đầu ra theo bất kỳ cách nào. Mục đích duy nhất của họ là mô tả cách thức và lý do mã hoạt động cho các nhà phát triển khác và chính bạn

Trong bài viết này, chúng ta sẽ xem xét cách bình luận mã JavaScript, loại bình luận nào tồn tại và một số phương pháp hay nhất

Nhận xét một dòng thường được sử dụng để nhận xét một phần của dòng hoặc toàn bộ dòng mã. Nhận xét một dòng trong JavaScript bắt đầu bằng //. Trình thông dịch sẽ bỏ qua mọi thứ ở bên phải của chuỗi điều khiển này cho đến cuối dòng

Hãy xem một ví dụ về nhận xét một dòng đang hoạt động

Ở đây, chúng tôi đang sử dụng nhận xét một dòng để mô tả dòng mã tiếp theo đang làm gì
Nếu chú thích một dòng xuất hiện ở cuối dòng mã, nó được gọi là chú thích nội tuyến

Chúng thường được sử dụng để thêm chú thích nhanh

Nếu chúng tôi muốn thêm một ghi chú trải rộng trên nhiều dòng, chúng tôi có thể chọn nhận xét nhiều dòng hoặc nhận xét cấp khối

Nhận xét nhiều dòng bắt đầu bằng /* và kết thúc bằng */

Ở đây, một bình luận nhiều dòng được sử dụng để mô tả tic-tac-toe. Nói chung, chú thích nhiều dòng được sử dụng để giới thiệu và giải thích một đoạn mã, trong đó một dòng/câu đơn lẻ là không đủ

Một loại bình luận nhiều dòng khác đôi khi cũng có thể được nhìn thấy

Thông thường, những nhận xét này có thể bao gồm thông tin về mã tiến hành, chẳng hạn như các tham số của hàm hoặc thậm chí là tác giả của mã

Những nhận xét này được gọi là DocStrings, vì về cơ bản chúng là các chuỗi (nhận xét) cấu thành tài liệu về mã của bạn

Những loại nhận xét này thực sự hữu ích cho các nhà phát triển khác trong nhóm của bạn, vì bạn có thể làm rõ đầu vào dự kiến ​​là gì, đầu ra là gì cũng như liên hệ với ai nếu cần.

Một lợi ích bổ sung là bạn có thể tạo tài liệu dựa trên các DocStrings này

Bên cạnh việc ghi chú, nhận xét cũng có thể được sử dụng để ngăn chặn nhanh chóng việc thực thi mã cho mục đích gỡ lỗi. Điều này có thể xảy ra vì Công cụ JavaScript không diễn giải mã nhận xét. Điều này được gọi là nhận xét mã

Nếu có một dòng sai, điều đó gây ra sự cố, chúng ta chỉ cần "nhận xét nó" để vô hiệu hóa nó mà không cần xóa dòng. Điều này có thể được ghép nối với các trình gỡ lỗi thực tế để giúp bạn đánh giá những gì đang diễn ra

Hãy xem xét đoạn mã sau

Nếu chúng tôi muốn xóa câu lệnh thứ hai, nhưng không muốn xóa nó mãi mãi, chúng tôi chỉ cần nhận xét nó ra ngoài

Mẹo chuyên nghiệp. Trong hầu hết các trình soạn thảo mã, chúng ta có thể sử dụng phím tắt Ctrl + / cho Windows và Cmd + / cho Mac để nhận xét một dòng mã

Ngoài ra, bạn cũng có thể nhận xét toàn bộ các phần nếu bạn không chắc mình có xóa chúng hay không

Hãy xem hướng dẫn thực hành, thực tế của chúng tôi để học Git, với các phương pháp hay nhất, tiêu chuẩn được ngành chấp nhận và bao gồm bảng gian lận. Dừng các lệnh Git trên Google và thực sự tìm hiểu nó

Trước hết, bình luận không phải là cái cớ để viết mã không thể đọc được, và sau đó chỉ sửa nó bằng năm đoạn bình luận giải thích nó. Trước tiên, chúng tôi phải tập trung vào việc viết mã rõ ràng, dễ hiểu, mã này có thể được cải thiện sau này bằng các nhận xét mang tính xây dựng

Sử dụng nhận xét để giải thích lý do tại sao bạn đã làm điều gì đó chứ không phải cách bạn đã làm điều đó. Nếu bạn thấy mình đang giải thích cách bạn đã làm điều gì đó, thì đã đến lúc lùi lại một bước và cấu trúc lại mã của bạn thành một thứ gì đó dễ hiểu

Một lời khuyên khác là đừng viết những bình luận hiển nhiên và thừa về bản chất. Ví dụ, nhận xét sau đây là hoàn toàn không cần thiết

Có những công cụ hữu ích, chẳng hạn như JSDOC 3 có thể tạo tài liệu, chỉ dựa trên nhận xét trong mã của bạn, được định dạng là DocStrings nêu trên

Phần kết luận

Trong bài viết này, chúng ta đã tìm hiểu xem bình luận là gì và cách tạo bình luận trong JavaScript. Chúng tôi đã xem xét các loại nhận xét khác nhau - nhận xét một dòng và nhiều dòng, cũng như các Tài liệu JavaScript đã đề cập

Chúng tôi cũng đã xem cách gỡ lỗi mã của mình bằng kỹ thuật gọi là "nhận xét ngoài" và cuối cùng đã tổng kết một số phương pháp nhận xét tốt

JavaScript hỗ trợ loại nhận xét nào?

/* trong JavaScript là gì?

Tại sao nhận xét được sử dụng trong JavaScript?

Nhận xét trong JavaScript Lớp 11 là gì?