Hướng dẫn javascript summary comments

Hi các bạn! Trong bài hướng dẫn này, chúng ta sẽ cùng nhau tìm hiểu về JavaScript Comments, tại sao bạn nên sử dụng chúng và cách sử dụng chúng thông qua các ví dụ nhé 😋😊.

JavaScript Comments là những gợi nhớ, lưu ý hoặc mô tả một đoạn code mà lập trình viên có thể thêm vào một chương trình Javascript. Các comments này sẽ bị bỏ qua bởi các trình biên dịch.

Trong Javascript, có hai cách để thêm comment vào code:

1. // - Single Line Comments - Comment trên một dòng
2. /* */ - Multi-line Comments - Comment trên nhiều dòng

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

Ví dụ:

const website = "Homiedev.com";

// Hiển thị tên website trên console
console.log("Đây là website " + website);

Ở ví dụ trên, Hiển thị tên website trên console là comment.

Chúng ta có thể tạo một comment ngay phía sau đoạn code của chúng ta.

const website = "Homiedev.com";

console.log("Đây là website " + website); // Hiển thị tên website trên console

Trong Javascript, Những đoạn văn bản giữa /* và */ là một Multi-line Comment.

Ví dụ:

const website = "Đây là website Homiedev";

/* const website = "Homiedev.com";

console.log("Đây là website " + website); */

console.log(website);

Để tiết kiệm thời gian, các bạn có thể sử dụng phím tắt để comment. Đối với hầu hết các code editors ví dụ như: vs code,... chúng ta sử dụng Ctrl + / cho Windows và Cmd + / cho Mac.

Chúng ta hay xem một số gợi ý sau để sử dụng comment ở hoàn cảnh thích hợp, tránh comment tràn lan nhé ^^.

1. Code - how và Comments - why

Chúng ta nên tránh viết code hoạt động như thế nào (how) trong các comment. Code sẽ có thể tự giải thích cách hoạt động của chính nó.

// Do
let p = 3.14; // Làm tròn số Pi
let c = 2 * p * 5; // Tính chu vi hình tròn có bán kính 5 (2*pi*r)
// Don't
let p = 3.14; // Khởi tạo giá trị biến p
let c = 2 * p * 5 // Nhân giá trị p cho 2 và 5

1. Comment không cần quá chi tiết

Sử dụng comment cho các đoạn code là cần thiết. Tuy nhiên, bạn không nên lạm dụng nó bằng cách mô tả code một cách quá chi tiết. Điều này có thể ảnh hưởng không tốt đến khả năng đọc code của chúng ta.

// Do
/*
 Lấy list users từ database
 */
async function getUsers() {
 // ...
}
// Don't
/*
 Xử lý bất đồng bộ, lấy danh sách users bằng cách gọi truy vấn cơ sở dữ liệu.
 */
async function getUsers() {
 // ...
}

1. Tránh viết tắt

Chúng ta không nên sử dụng các từ viết tắt tiếng anh như aka, viz,... hay từ viết tắt như khi sử dụng tin nhắn cho bạn bè hằng ngày vì không phải ai cũng hiểu chúng. Tuy những từ này làm cho câu của chúng ta ngắn gọn, nhưng nó không tuân theo mục đích truyền tải thông điệp rõ ràng đến người đọc.

// Do
/*
  curPage, in other words current page
 */
// Don't
/*
 curPage, viz. current page
*/

1. Sử dụng comment trước code

Mục đích chính của việc viết comment là để cho người đọc hiểu đoạn code của chúng ta. Vì vậy chúng ta nên sử dụng các comment phía trên các đoạn code, điều này sẽ giúp tiết kiệm nhiều thời gian cho người đọc.

/**
 get thông tin user bằng userId
 @param {string} userId - Id của user
*/
function getInfoUser(userId) {
 // ...
}

1. Giải thích các giá trị số

Chúng ta có thể sử dụng các comment để giải thích các đơn vị được sử dụng và phạm vi của các giá trị số.

Là một developer, chúng ta sẽ không chỉ viết code cho chính mình mà còn có thể phải làm việc với code do người khác viết.

Để code sau này đọc lại dễ hiểu hơn, mình khuyên các bạn hãy viết comment cho code của chính mình 😁. Ngoài ra, nếu làm việc nhóm, những người khác khi đọc code của bạn sẽ hiểu code dễ dàng hơn.

Hy vọng bài viết giúp ích cho các bạn. Chúc các bạn học tốt 😊.