Trong hướng dẫn này, bạn sẽ tìm hiểu về các nhận xét JavaScript, tại sao bạn nên sử dụng chúng và cách sử dụng chúng với sự trợ giúp của các ví dụ.
Nhận xét JavaScript là gợi ý mà một 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ã:
//– Single Line Comments/* */-Multi-line Comments
Nhận xét dòng đơn
Trong JavaScript, bất kỳ dòng nào bắt đầu bằng //một dòng chú thích. Ví dụ,
name = "Jack";
// printing name on the console
console.log("Hello " + name);
Đây, // printing name on the consolelà một bình luận.
Bạn cũng có thể sử dụng bình luận 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 Javacfscript, bất kỳ văn bản nào giữa /*và */là một nhận xét nhiều dòng. Ví dụ,
/* 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 để thực hiện các quy tắc của trò chơi, bình luận ở trên là một ví dụ điển hình mà bạn có thể sử dụng bình luận nhiều dòng.
Sử dụng nhận xét để gỡ lỗi
Chú thích cũng có thể được sử dụng để vô hiệu hóa mã để ngăn 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 các chú thích để vô hiệu hóa nó không được thực thi; đây có thể là một công cụ gỡ lỗi có giá trị.
console.log("some code");
// console.log("Error code);
console.log("other code");
Mẹo chuyên nghiệp: Hãy nhớ phím tắt để sử dụng nhận xét; nó có thể thực sự hữu ích. Đối với hầu hết các trình chỉnh sửa mã, nó Ctrl + /dành cho Windows và Cmd + /Mac.
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 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 giỏi.
Lưu ý: Nhận xét không nên thay thế cho cách giải thích mã viết kém bằng tiếng Anh. Bạn nên luôn viết mã có cấu trúc tốt và tự giải thích. Và, sau đó sử dụng bình luận.