Hướng dẫn JavaScript này giải thích cách sử dụng nhận xét bằng ngôn ngữ JavaScript với cú pháp và ví dụ
Sự miêu tả
Trong JavaScript, bạn có thể đặt nhận xét trong mã của mình mà không được thực thi như một phần của mã. Những nhận xét này có thể xuất hiện trên một dòng hoặc trải dài trên nhiều dòng. Hãy khám phá cách nhận xét mã JavaScript của bạn
JavaScript hỗ trợ các kiểu nhận xét giống như ngôn ngữ C và C++
cú pháp
Có hai cú pháp mà bạn có thể sử dụng để tạo nhận xét trong JavaScript
Cú pháp Sử dụng ký hiệu /* comment goes here */
6
/* comment goes here */Cú pháp để tạo một bình luận trong JavaScript sử dụng ký hiệu // là
// comment goes hereMột nhận xét bắt đầu bằng ký hiệu // phải ở cuối một dòng trong mã JavaScript của bạn với dấu ngắt dòng sau nó. Phương pháp nhận xét này chỉ có thể kéo dài một dòng trong JavaScript và phải ở cuối dòng
Cú pháp Sử dụng các ký hiệu /* comment goes here */
7 và /* comment goes here */
0
/* comment goes here *//* comment goes here */Cú pháp để tạo một bình luận trong JavaScript sử dụng ký hiệu /* và */ là
/* comment goes here */Một nhận xét bắt đầu bằng ký hiệu /* và kết thúc bằng */ có thể ở bất kỳ đâu trong mã JavaScript. Phương pháp nhận xét này có thể kéo dài nhiều dòng trong JavaScript
Ví dụ - Nhận xét trên một dòng
Hãy xem một ví dụ cho biết cách tạo nhận xét trong JavaScript trên một dòng
Ví dụ
Đây là một nhận xét xuất hiện trên dòng riêng của nó trong JavaScript
/* Author: TechOnTheNet.com */
var h = 100;Đây là một nhận xét xuất hiện ở cuối dòng trong JavaScript
var h = 100; /* Author: TechOnTheNet.com */hoặc
var h = 100; // Author: TechOnTheNet.comVí dụ - Nhận xét trên nhiều dòng
Bạn cũng có thể tạo nhận xét kéo dài nhiều dòng trong mã JavaScript của mình
Ví dụ
/*
Author: TechOnTheNet.com
Purpose: To show a comment that spans multiple lines in JavaScript
*/
var h = 100;Nhận xét này trải dài trên nhiều dòng trong JavaScript và trong ví dụ này, nó trải dài trên 4 dòng
JavaScript sẽ giả định rằng mọi thứ sau ký hiệu /* là một nhận xét cho đến khi nó chạm tới ký hiệu */, ngay cả khi nó kéo dài nhiều dòng trong mã JavaScript
Ví dụ - Nhận xét để ngăn chặn việc thực thi mã
Bạn cũng có thể sử dụng nhận xét để ngăn các dòng mã JavaScript được thực thi
Ví dụ
// var h = 100;tag = tag.toUpperCase[];
Nhận xét này sẽ ngăn biến h được khai báo với giá trị 100 trong JavaScript
Bạn cũng có thể ngăn nhiều dòng JavaScript được thực thi
Ví dụ
________số 8Bằng cách sử dụng các ký hiệu /* và */, chúng tôi đã ngăn cả hai dòng mã JavaScript được thực thi. Trong ví dụ này, cả việc khai báo biến h cũng như việc chuyển đổi biến có tên tag thành chữ hoa đều bị ngăn chặn.
Nhận xét JavaScript là cách có ý nghĩa để truyền tải thông điệp. Nó được sử dụng để thêm thông tin về mã, cảnh báo hoặc đề xuất để người dùng cuối có thể dễ dàng hiểu mã
Nhận xét JavaScript bị bỏ qua bởi công cụ JavaScript tôi. e. được nhúng trong trình duyệt
Ưu điểm của nhận xét JavaScript
Có hai ưu điểm chính của nhận xét JavaScript
- Để làm cho mã dễ hiểu Nó có thể được sử dụng để xây dựng mã để người dùng cuối có thể dễ dàng hiểu mã
- Để tránh mã không cần thiết Nó cũng có thể được sử dụng để tránh mã được thực thi. Đôi khi, chúng tôi thêm mã để thực hiện một số hành động. Nhưng sau một thời gian, có thể cần phải tắt mã. Trong trường hợp như vậy, tốt hơn là sử dụng nhận xét
Các loại nhận xét JavaScript
Có hai loại bình luận trong JavaScript
- Nhận xét một dòng
- Nhận xét nhiều dòng
JavaScript Dòng đơn Nhận xét
Nó được thể hiện bằng dấu gạch chéo kép [//]. Nó có thể được sử dụng trước và sau tuyên bố
Hãy xem ví dụ về nhận xét một dòng i. e. thêm vào trước tuyên bố
Kiểm tra nó ngay bây giờHãy xem ví dụ về nhận xét một dòng i. e. thêm vào sau tuyên bố
Nhận xét nhiều dòng JavaScript
Nó có thể được sử dụng để thêm các bình luận đơn cũng như nhiều dòng. Vì vậy, nó là thuận tiện hơn
Nó được thể hiện bằng dấu gạch chéo về phía trước với dấu hoa thị rồi dấu hoa thị với dấu gạch chéo về phía trước. Ví dụ
Nó có thể được sử dụng trước, sau và giữa câu lệnh
Kiểm tra nó ngay bây giờNhận xét JavaScript được sử dụng để viết ghi chú trong mã của bạn hoặc để tắt các phần mã mà không xóa chúng. Nhận xét được thực hiện bằng JavaScript bằng cách thêm
/* comment goes here *//* comment goes here *//* comment goes here */Nhận xét về mã là một tính năng cốt lõi của một số ngôn ngữ lập trình. Ý tưởng đằng sau các nhận xét về mã là trong khi mã của bạn sẽ được máy tính đọc, thì mã của bạn cũng sẽ được đọc bởi con người và vì vậy điều quan trọng là mọi người phải dễ hiểu mã mà bạn viết
Nhận xét cho phép bạn theo dõi mã của mình khi bạn đang lập trình và cung cấp cho bạn khả năng ghi chú có thể hữu ích trong tương lai. Ngoài ra, nếu bạn đang làm việc theo nhóm, viết nhận xét sẽ giúp đảm bảo rằng mã của bạn có thể đọc được cho tất cả những người có thể phải đóng góp cho công việc của bạn
Tìm trận đấu Bootcamp của bạn
- Career Karma kết hợp bạn với các bootcamp công nghệ hàng đầu
- Truy cập học bổng độc quyền và các khóa học chuẩn bị
Tên
Họ
Điện thoại .
By continuing you agree to our Terms of Service and Privacy Policy , and you consent to receive offers and opportunities from Career Karma by telephone, text message, and email.
Trong hướng dẫn này, chúng ta sẽ thảo luận về cách viết bình luận trong JavaScript. Chúng tôi sẽ bắt đầu bằng cách thảo luận về giá trị của nhận xét trong JavaScript, sau đó chúng tôi sẽ xem xét cú pháp bạn có thể sử dụng để viết nhận xét trong JavaScript
Viết Nhận xét về Mã
Nhận xét là một phần thiết yếu để viết mã có thể đọc được và có thể bảo trì. Sự thật là mặc dù bạn có thể hiểu mã bạn đang viết ngày hôm nay, nhưng không có gì đảm bảo rằng bạn sẽ có thể mô tả hiệu quả những gì nó làm vào ngày mai. Ngoài ra, nếu bạn đang làm việc với người khác, khả năng cao là họ có thể không hiểu một số mã bạn viết
Đó là nơi nhận xét đến. Nhận xét là các câu lệnh bị trình biên dịch bỏ qua và có thể được sử dụng để giải thích mã JavaScript của bạn
Là một nhà phát triển, viết nhận xét về mã của riêng bạn sẽ cho phép bạn theo dõi hiệu quả hơn những gì bạn đang làm. Khi bạn đang viết mã của mình, bạn có thể viết ra các ghi chú sẽ giúp bạn hiểu rõ hơn về mã của mình và tìm ra ý định đằng sau mã mà bạn đã viết trước đó. Viết nhận xét cũng sẽ hữu ích cho bất kỳ người nào khác có thể xem mã của bạn, vì nhận xét có thể sẽ giúp họ hiểu sâu hơn về cách mã của bạn hoạt động.
Mỗi nhà phát triển viết nhận xét khác nhau, nhưng quy tắc chung là các nhận xét nên được sử dụng để giải thích ý định đằng sau mã của bạn. Xét cho cùng, mã của bạn tự nói lên điều đó, nhưng lý do đằng sau việc viết mã theo một cách nhất định thường không. Vì vậy, bằng cách viết nhận xét, bạn có thể giải thích lý do tại sao bạn tiếp cận một vấn đề theo một cách nhất định, giúp cả bạn và những người khác dễ dàng hiểu cách chương trình của bạn hoạt động hơn nữa.
Nhận xét JavaScript
Có hai loại bình luận được sử dụng trong JavaScript. bình luận một dòng và bình luận khối
Nhận xét một dòng được viết bằng hai dấu gạch chéo lên [//] và được viết trên một dòng mã. Mọi ký tự theo sau câu lệnh
/* comment goes here *//* comment goes here */Nhận xét khối được viết bằng thẻ mở và thẻ đóng và cho phép bạn viết nhận xét trải dài trên nhiều dòng. Các thẻ mở và đóng cho các bình luận khối là
var chocolate = ['Dark', 'Milk', 'White', 'Hazelnut', 'Caramel']; // var flavors ['Strawberry Deluxe', 'Hazelnut Praline', 'Vanilla', 'Triple Truffle'];
0 để mở bình luậnvar chocolate = ['Dark', 'Milk', 'White', 'Hazelnut', 'Caramel']; // var flavors ['Strawberry Deluxe', 'Hazelnut Praline', 'Vanilla', 'Triple Truffle'];
1 để đóng bình luận
Nhận xét khối đôi khi được gọi là nhận xét nhiều dòng và giống với nhận xét nhiều dòng CSS. Đây là một ví dụ về bình luận khối trong JavaScript
/* comment goes here */Tất cả mã giữa thẻ mở và thẻ đóng của chúng tôi sẽ bị trình biên dịch bỏ qua
"Career Karma bước vào cuộc đời tôi khi tôi cần nó nhất và nhanh chóng giúp tôi phù hợp với bootcamp. Hai tháng sau khi tốt nghiệp, tôi đã tìm được công việc mơ ước phù hợp với giá trị và mục tiêu của mình trong cuộc sống. "
Venus, Kỹ sư phần mềm tại Rockbot
Find Your Bootcamp MatchMỗi loại nhận xét có thể được sử dụng để giải thích mã của bạn và thảo luận về ý định đằng sau mã của bạn. Đây là một ví dụ về một chú thích được sử dụng để giải thích một khai báo biến cơ bản
// Khai báo biến “sô cô la” để lưu trữ các loại sô cô la dưới dạng một mảng
var sô cô la = [‘Đậm’, ‘Sữa’, ‘Trắng’, ‘Hạt phỉ’, ‘Caramen’];
Nhận xét trong bất kỳ ngôn ngữ lập trình nào phải được cập nhật thường xuyên khi mã thay đổi. Vì vậy, nếu chúng tôi quyết định rằng tên biến của chúng tôi sẽ được đổi tên thành “chocolate_types”, thì chúng tôi nên cập nhật nhận xét của mình để đảm bảo rằng nó phản ánh tên biến mới. Thật vậy, khi các chương trình trở nên lớn hơn, chúng thường thay đổi đáng kể, vì vậy điều quan trọng là bạn phải cập nhật nhận xét cùng với mã của mình
Nhận xét ra mã
Nhận xét thường được sử dụng cho một trong hai mục đích. Đầu tiên, như chúng ta đã thảo luận trong suốt bài viết này, là giải thích mục đích đằng sau mã của bạn và làm rõ bất kỳ thủ tục khó hiểu nào. Thứ hai là ngăn mã chạy trong khi bạn đang thử nghiệm
Nhận xét mã cho phép bạn dừng chạy một dòng hoặc nhiều dòng mã mà không xóa hoàn toàn mã khỏi chương trình của bạn. Cách sử dụng nhận xét này là phổ biến khi gỡ lỗi, vì bạn có thể muốn thử nhiều giải pháp cho một vấn đề và giữ lại mã của mình cho lần sau
Dưới đây là một ví dụ về nhận xét nhận xét một dòng mã
var chocolate = ['Dark', 'Milk', 'White', 'Hazelnut', 'Caramel']; // var flavors ['Strawberry Deluxe', 'Hazelnut Praline', 'Vanilla', 'Triple Truffle'];
Khi chúng tôi thực thi chương trình của mình, trình biên dịch sẽ chỉ thực thi dòng mã khai báo biến
var chocolate = ['Dark', 'Milk', 'White', 'Hazelnut', 'Caramel']; // var flavors ['Strawberry Deluxe', 'Hazelnut Praline', 'Vanilla', 'Triple Truffle'];2 Chúng tôi đã nhận xét biến
var chocolate = ['Dark', 'Milk', 'White', 'Hazelnut', 'Caramel']; // var flavors ['Strawberry Deluxe', 'Hazelnut Praline', 'Vanilla', 'Triple Truffle'];3 vì nó có lỗi và chúng tôi cần gỡ lỗi sự cố. Trong trường hợp này, chúng tôi đã quên đặt dấu bằng giữa tên biến của chúng tôi
var chocolate = ['Dark', 'Milk', 'White', 'Hazelnut', 'Caramel']; // var flavors ['Strawberry Deluxe', 'Hazelnut Praline', 'Vanilla', 'Triple Truffle'];4 và giá trị của biến [mảng hương vị của chúng tôi]
Hãy chia nhỏ từng loại nhận xét mà chúng ta đã thảo luận và khám phá cách chúng có thể được sử dụng