Comment trong JavaScript

Comment trong JavaScript

Anh NguyễnBạn nghĩ gì về bài viết này?

Giới thiệu

Trong bài viết này, bạn sẽ tìm hiểu về Comment trong JavaScript, tại sao chúng ta lại sử dụng chúng và sử dụng chúng như thế nào cho hợp lý.

Comment trong JavaScript (hay còn gọi là chú thích) 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ụ của JavaScript như trình thông dịch, biên dịch,…

Có 2 cách để thêm chú thích vào trong đoạn mã của bạn:

  • // – Chú thích 1 dòng
  • /* */ – Chú thích nhiều dòng

Chú thích 1 dòng

Trong JavaScript, bất kỳ dòng nào bắt đầu bằng // là một chú thích. Ví dụ:

name = "Jack";

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

Ở đây, // printing name on the console là 1 chú thích.

Bạn cũng có thể comment như sau:

name = "Jack";

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

Chú thích nhiều dòng

Trong JavaScript, bất kỳ văn bản nào giữa /* và */ cũng là một chú thích. 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 thi trò chơi, chú thích ở trên là một ví dụ điển hình mà bạn có thể sử dụng comment nhiều dòng.

Sử dụng Comment khi Debug

Chú thích cũng có thể được sử dụng để vô hiệu hóa đoạn 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: Hãy ghi nhớ phím tắt để sử dụng chú thích. Nó có thể rất hữu ích đối với hầu hết các trình soạn thảo mã, đó là Ctrl + / cho Windows và Cmd + / cho Mac.

Giúp đoạn mã dễ hiểu hơn

Là một nhà lập trình viên JavaScript, bạn sẽ không chỉ viết mã mà còn phải sửa đổi mã do các lập trình viên khác viết.

Nếu bạn viết chú thích về mã của mình, nó sẽ giúp bạn có thể đọc lại chương trình dễ dàng hơn và các lập trình viên khác cũng vậy. Sẽ không mất công sức để xem cái đoạn mã đó viết cái gì, xử lý những cái gì, thực thi ra sao.

Theo nguyên tắc chung, hãy sử dụng các chú thích để giải thích tại sao bạn làm điều đó chứ đừng giải thích cách bạn làm điều đó để chứng minh rằng mình giỏi.

Ghi nhớ: Đừng giải thích tại sao bạn viết mã kém, hãy cố gắng viết mã thật tốt, hiểu được luồng xử lý để tự mình có thể comment vào đó! Nếu không được thì nên nhờ sự giúp đỡ của đồng nghiệp và leader của mình để có thể viết mã tốt hơn.

Các bạn có thể tham khảo các bài viết hay về JavaScript tại đây.

Hãy tham gia nhóm Học lập trình để thảo luận thêm về các vấn đề cùng quan tâm.

Bình luận