Có 2 loại chú thích JavaScript: một dòng và nhiều dòng. Xem thời điểm sử dụng chúng với các ví dụ và cũng sử dụng các nhận xét để ngăn chặn việc thực thi khi kiểm tra mã thay thế.

Bạn đang xem : cách viết nhận xét trong javascript

Mối quan tâm đầu tiên trong lập trình thường là cách máy đọc mã diễn giải nó. Thật vậy, việc tính đến những người sẽ đọc và làm việc với mã là rất quan trọng. Cho dù bạn nên làm việc với một nhóm hay một mình, bạn sẽ cần học cách nhận xét và cấu trúc mã cho người đọc một cách phù hợp.

Chú thích là chú thích trong mã nguồn của chương trình mà trình thông dịch bỏ qua và do đó không ảnh hưởng đến kết quả thực của mã. Nhận xét thường có thể cực kỳ hữu ích trong việc hiểu mục đích của một phần mã của bạn.

Là một nhà phát triển, việc tìm hiểu sâu hơn về mã do bất kỳ ai khác viết mà chưa được nhận xét thích hợp có thể gây khó chịu và rất dễ quên mã của bạn thực sự có ý định gì khi bạn không còn tham gia vào dự án đó nữa. Nếu bạn nhận xét mã của mình đúng cách vào đúng thời điểm, nó sẽ trở thành một thói quen lập trình tốt và bạn sẽ tránh được những hiểu lầm trong tương lai.

Có một câu nói sáo rỗng nổi tiếng rằng “Mã tốt là tự ghi lại tài liệu.” Và khi bắt đầu một dự án mới, bạn nên nghĩ đến việc làm rõ và tạo tài liệu cho mã của mình, điều này có thể được thực hiện bằng nhận xét.

Nhận xét JavaScript có thể được sử dụng theo hai cách: để làm rõ mã JavaScript và làm cho nó dễ hiểu hơn; để ngăn chặn việc thực thi khi kiểm tra mã thay thế.

Có hai loại nhận xét JavaScript khác nhau:

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

//

) được sử dụng để viết các nhận xét một dòng:

  // Tôi là một nhận xét.  

Hai tiến lên dấu gạch chéo () được sử dụng để viết nhận xét trên một dòng:

JavaScript sẽ bỏ qua (sẽ không thực thi) bất kỳ văn bản nào giữa dấu gạch chéo và cuối dòng.

Xem ví dụ này sử dụng chú thích một dòng trước mỗi dòng mã:

Ví dụ

 

& lt;

html

& gt;

& lt;

head

& gt;

& lt;

title

& gt;

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

& lt; /

title

& gt;

& lt; /

head

& gt;

& lt;

body

& gt;

& lt;

h2

id

=

" myHeading "

& gt;

& lt; /

h2

& gt;

& lt;

p

id

=

" myParagraph "

& gt;

& lt; /

p

& gt;

& lt;

script

& gt;

document

.getElementById (

"myHeading"

) .innerHTML =

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

;

document

.getElementById (

"myParagraph"

) .innerHTML =

" Tôi có nhận xét trong mã JavaScript của mình! "

;

& lt; /

script

& gt;

& lt; /

body

& gt;

& lt; /

html

& gt;


Hãy tự mình thử »

Xem Thêm  CSS: có Bộ chọn (và hơn 4 Ví dụ) | Thủ thuật CSS - lớp css chứa bộ chọn

Nhận xét một dòng được coi là nhận xét nội dòng khi chúng xuất hiện ở cuối dòng mã.

Để có chú thích nhanh về các đoạn nội dung nhỏ, cụ thể, có thể sử dụng nhận xét nội tuyến. Vì nhận xét chỉ liên quan đến dòng chính xác mà nó được viết, nên đây là loại nhận xét rõ ràng nhất.

Ví dụ

Nhận xét nội tuyến JavaScript

Nhận xét Nội tuyến JavaScript

let a = 55; // gán giá trị số cho a
cho b = a + 4; // gán tổng a + 4 cho b
// Viết b vào bản demo:
console.log (b);

Hãy nhớ rằng không có cách nào để kết thúc một dòng nhận xét trên một dòng, vì vậy hãy đảm bảo không đặt bất kỳ mã nào sauCú pháp

//

.

Mặc dù các nhận xét nội tuyến có thể hữu ích, nhưng chúng nên được sử dụng cẩn thận. Mã có vô số nhận xét nội tuyến sẽ dễ trở nên lộn xộn, khó đọc.

Nhận xét nhiều dòng, được biết đến rộng rãi là nhận xét khối, bắt đầu bằng / *
và kết thúc bằng * /. Nếu bạn biết CSS, thì bạn đã quen thuộc với các nhận xét cấp khối.

JavaScript sẽ bỏ qua bất kỳ văn bản nào giữa / * và * /.

   

Cả hai nhận xét một dòng và nhiều dòng được viết phía trên mã để làm rõ mã.

Xem một ví dụ sử dụng nhận xét nhiều dòng (khối nhận xét) để đơn giản hóa mã:

Ví dụ

 

& lt;

html

& gt;

& lt;

head

& gt;

& lt;

title

& gt;

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

& lt; /

title

& gt;

& lt; /

head

& gt;

& lt;

body

& gt;

& lt;

h1

id

=

" myHeading "

& gt;

& lt; /

h1

& gt;

& lt;

p

id

=

" myParagraph "

& gt;

& lt; /

p

& gt;

& lt;

script

& gt;

document

.getElementById (

"myHeading"

) .innerHTML =

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

;

document

.getElementById (

"myParagraph"

) .innerHTML =

" Tôi có nhiều ý kiến ​​bình luận! "

;

& lt; /

script

& gt;

& lt; /

body

& gt;

& lt; /

html

& gt;


Hãy tự mình thử »

Lưu ý rằng thông thường nhất là sử dụng nhận xét một dòng. Nhận xét khối thường được sử dụng cho tài liệu chính thức. Và đôi khi chúng sẽ bao gồm thông tin chi tiết về tệp lập trình, bao gồm tên, phiên bản và tác giả của tập lệnh.

Xem Thêm  Máy in là gì? - in làm gì

Nhận xét có thể được sử dụng để ngăn chặn việc thực thi mã vì lý do thử nghiệm và gỡ lỗi một cách dễ dàng và nhanh chóng. Nó được gọi là “bình luận về mã”.

Thêm // vào trước một dòng mã sẽ thay đổi các dòng mã từ một dòng thực thi thành nhận xét.

Khi có lỗi trong mã cụ thể mà bạn đã viết, nhận xét về các phần sẽ ngăn chúng chạy và việc xác định nguồn gốc của sự cố có thể hữu ích. Để kiểm tra các kết quả khác nhau, bạn cũng có thể sử dụng nó để chuyển đổi giữa các mã.

Xem một ví dụ sử dụng // để ngăn việc thực thi một trong các dòng mã:

Ví dụ

 

& lt;

html

& gt;

& lt;

head

& gt;

& lt;

title

& gt;

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

& lt; /

title

& gt;

& lt; /

head

& gt;

& lt;

body

& gt;

& lt;

h2

& gt;

Nhận xét JavaScript để ngăn chặn việc thực thi

& lt; /

h2

& gt;

& lt;

h1

id

=

" myHeading "

& gt;

& lt; /

h1

& gt;

& lt;

p

id

=

" myParagraph "

& gt;

& lt; /

p

& gt;

& lt;

script

& gt;

document

.getElementById (

"myParagraph"

) .innerHTML =

" Tôi có một khối nhận xét không được thực thi. "

;

& lt; /

script

& gt;

& lt; /

body

& gt;

& lt; /

html

& gt;


Hãy tự mình thử »

Dựa trên kích thước của phần được chuyển đổi, cả nhận xét một dòng và nhận xét khối đều có thể được sử dụng để nhận xét về mã.

Nhận xét về mã có thể hữu ích khi tìm ra logic của dự án khi bạn xác định vị trí của lỗi hoặc đánh giá các dòng mã cung cấp nhiều tiện ích nhất.

Nhận xét mã chỉ nên được thực hiện trong mục đích thử nghiệm. Không để lại các đoạn mã đã nhận xét trong tập lệnh cuối cùng của bạn.

Máy tính diễn giải mã JavaScript, nhưng các nhà phát triển khác sẽ luôn đọc mã JavaScript cũng như cho chính bạn trong tương lai.

Đừng tiếc thời gian của bạn để bỏ chú thích thường xuyên về các phần mã phức tạp sẽ là một lợi thế trong tương lai, giúp bạn và đồng nghiệp của bạn hiểu mục đích của đoạn mã bạn đã viết dễ dàng hơn.


Xem thêm những thông tin liên quan đến chủ đề cách viết bình luận bằng javascript

Add Comment Javascript Part 3

  • Tác giả: Web Developerify
  • Ngày đăng: 2016-05-11
  • Đánh giá: 4 ⭐ ( 2058 lượt đánh giá )
  • Khớp với kết quả tìm kiếm: How to add new comment using javascript locally with some basic styling of form objects.
Xem Thêm  JavaScript HTML - liên kết html với javascript

Sáu mẹo đơn giản giúp học lập trình Javascript nhanh hơn

  • Tác giả: completejavascript.com
  • Đánh giá: 5 ⭐ ( 5484 lượt đánh giá )
  • Khớp với kết quả tìm kiếm: Khi mọi người cố gắng học lập trình Javascript, họ thường trải qua những thử thách giống nhau. Sau đây là sáu mẹo giúp học lập trình JavaScript nhanh hơn.

Phương pháp Hiển thị / Xuất dữ liệu trong Javascript

  • Tác giả: hanoiict.edu.vn
  • Đánh giá: 3 ⭐ ( 6669 lượt đánh giá )
  • Khớp với kết quả tìm kiếm: Trong bài hướng dẫn tự học lập trình Javascript này, bạn sẽ tìm hiểu cách hiển thị / xuất dữ liệu ra, cách in ra màn hình console, tạo thông báo hay in kết quả ra màn hình trong JavaScript…   Tại sao phải hiển thị dữ liệu?   Trong khi lập trình, có một số tình huống nhất định có thể cần phải hiển thị dữ liệu,

Cách thêm bình luận Facebook vào WordPress không cần plugin

  • Tác giả: bacsiseo.com
  • Đánh giá: 4 ⭐ ( 8878 lượt đánh giá )
  • Khớp với kết quả tìm kiếm: Bài viết này sẽ hướng dẫn bạn tích hợp phần bình luận của Facebook vào bài viết WordPress không cần plugin, thay thế cho phần bình luận mặc định của WordPress.

Thêm bình luận Facebook vào Ladipage

  • Tác giả: nguyenvietanh.net
  • Đánh giá: 5 ⭐ ( 2751 lượt đánh giá )
  • Khớp với kết quả tìm kiếm: Hướng dẫn thêm bình luận Facebook vào Ladipage nhanh chóng. Tăng tỉ lệ chuyển đổi cho landing page của bạn.

hỏi làm menu dropdow bằng javascript

  • Tác giả: viblo.asia
  • Đánh giá: 3 ⭐ ( 3624 lượt đánh giá )
  • Khớp với kết quả tìm kiếm: mình tìm hiểu cách làm menu dropdown bằng javascript ở www.w3schools rồi mà không thấy trên web chỉ cách tạo hiệu ứng chuyển sang trang khác ,dù ở web đó có chỉ nhưng toàn chỉ làm mấy cái menu drop…

Comment Trong JavaScript

  • Tác giả: www.codehub.com.vn
  • Đánh giá: 5 ⭐ ( 4911 lượt đánh giá )
  • Khớp với kết quả tìm kiếm: Comments trong JavaScript được sử dụng để giải thích code, làm cho code dễ đọc hơn. Ngoài ra, chúng còn được sử dụng để ngăn không cho 1 đoạn code nào đó được thực thi, nhằm thử nghiệm 1 đoạn code thay thế

Xem thêm các bài viết khác thuộc chuyên mục: Kiến thức lập trình

By ads_php