Sử dụng Comment trong lập trình JavaScript như thế nào cho hiệu quả?

#1

Đang ngồi ôn lại JavaScript thì đọc đến phần này thấy ngắn gọn và dễ hiểu nên muốn chia sẻ và thảo luận cùng với mọi người xem cách mà mọi người thường comment code của mình như thế nào.

COMMENTS

Nói về việc tạo ra một đoạn code mà dễ đọc và dễ bảo quản trong một thời gian dài thì Comment chính là những người bạn. Đoạn code mà có vẻ như là rõ ràng vào thời điểm hiện tại thì chưa chắc là nó sẽ rõ ràng trong tương lai khi mà bạn nhìn vào nó, nhất là trong một thời gian dài kể từ ngày mà bạn viết cái đoạn code đó. Comment có thể được đặt vào bên trong code của JavaScript theo hai cách đó là: comment trên nhiều dòng và comment trên một dòng.

Kiểu comment trên nhiều dòng trong JavaScript sẽ rất là quen thuộc với bạn khi mà bạn đã từng lập trình với ngôn ngữ C. Kiểu comment trên nhiều dòng sẽ bắt đầu và kết thúc bằng /* và */, giống như đoạn code mẫu bên dưới này:

/* Đây là một kiểu comment trên nhiều dòng trong JavaScript
Nó giống với kiểu comment theo phong cách của lập trình C vì nó có thể
kéo dài trên nhiều dòng trươc khi được đóng lại. */

Kiểu comment trên một dòng thì nó sẽ bắt đầu với dấu (//) và sẽ không có ký tự nào được yêu cầu để kết thúc một câu comment bởi vì nó chỉ kéo dài duy nhất trên một dòng. Đoạn code mẫu bên dưới sẽ giúp bạn hiểu rõ hơn:

// Đây là kiểu comment trên một dòng.

Việc sử dụng nhiều comment trên một dòng cùng một lúc là hoàn toàn hợp lệ, và chúng ta sử dụng chúng cho những khối comment ngắn, hơn là sử dụng kiểu comment trên nhiều dòng mà ta đã thấy ở bên trên. Ví dụ bên dưới sẽ cho ta hiểu rõ hơn về vấn đề này:

// Dưới đây là comment theo dạng khối.
// Đây là một trong nhiều dòng được sử dụng theo kiểu comment trên một dòng.
// Mỗi dòng phải được khai báo bằng hai dấu gạch chéo phía trước.

Mẹo: Bạn có thể sử dụng kiểu comment bằng hai dấu gạch chéo cho những comment nhỏ được kéo dài trên một dòng hoặc chỉ là vài dòng. Còn đối với những comment lớn như là một đoạn mã hay là một đoạn chương trình thì kiểu comment trên nhiều dòng là một sự lựa chọn tốt cho bạn bởi vì nó giúp bạn dễ dàng thêm hay xóa những thông tin.

4 Likes
#2

Mục tiêu là code sao cho ngoài Java docs ra thì không phải comment thêm gì cả…

1 Like
#3

Comment nhiều cũng không tốt, mà comment cái gì hiển nhiên qúa cũng không tốt. Khiêm đọc phần commenting trong CC2(Code Complete 2) chưa? Nói về vụ comment rất hay dấy.

Không nhớ chính xác chap nào nhưng nằm ở phần sau của quyển sách.

5 Likes
#4

Chap 7, phần 32. Clean Code thì Chapter 4. Em đang tham khảo viết 1 chuỗi 3 bài về Comment Code gồm: Tại sao phải Comment?, Thế nào là Bad Comment và Comment Code như thế nào mới hiệu quả.

5 Likes
#5

DuyNguyen đọc xong cho vài cái nhận xét nhé, Đạt cũng muốn thảo luận về vấn đề này :slight_smile:

#6

Em sẽ tạm thời ngưng WPF & MVVM lại viết cho xong 3 bài này, lý do là vừa bị chê comment code như không comment. Em sẽ cố hoàn thành sớm vậy, 2 cuốn đó mỗi cuốn đều dành hẳn 1 chương nói về vấn đề này cho nên đây cũng là vấn đề khá quan trọng.

4 Likes
#7

hiện tại thì mình chưa đọc cuốn code complete 2 mà đang đọc cuốn khác. Khi nào đọc đến quyển Code Complete 2 sẽ chú ý đến phần này. :slight_smile:

1 Like
#8

nếu bạn xài Sublime Text thì nó có 1 plug-in hỗ trợ sẵn việc comment… mình quên mất tên rồi :grin:

#9

mình đang hứng thú với thằng visual studio code :heart_eyes:

83% thành viên diễn đàn không hỏi bài tập, còn bạn thì sao?