Hướng dẫn why comments are used in javascript? - tại sao bình luận được sử dụng trong javascript?

JavaScript được xây dựng để đơn giản và dễ sử dụng, nhưng nó vẫn có thể tạo ra mã phức tạp dễ hiểu trong nháy mắt. Đối với những tình huống này, tiêu chuẩn JavaScript cung cấp hai cách để tạo nhận xét mã trong đó các nhà phát triển có thể giải thích bằng ngôn ngữ đơn giản những gì đang xảy ra.

Mặc dù một trình duyệt không thực hiện các bình luận của JavaScript, bao gồm cả các bình luận là một thông lệ quan trọng tốt nhất trong phát triển phần mềm. Gần như tất cả mã JavaScript có thể được hưởng lợi từ việc bổ sung các bình luận để giải thích cách thức hoạt động của nó; Thêm ý kiến ​​hữu ích là một dấu hiệu của chất lượng mã tốt.

Bài viết này bao gồm cách tạo các bình luận của JavaScript, cách họ sử dụng trong một chương trình và một số thực tiễn tốt nhất để tạo ra các nhận xét hiệu quả nhất có thể.

Viết ý kiến ​​JavaScript

Có hai cách khác nhau để viết bình luận trong JavaScript: trên một dòng hoặc trên nhiều dòng. Cú pháp cho mỗi loại bình luận là hơi khác nhau, nhưng có thể có một số sự chồng chéo giữa chúng về mặt phong cách nếu một nhà phát triển thích.

Ý kiến ​​dòng đơn

Bình luận JavaScript đơn bắt đầu với hai dấu gạch chéo về phía trước (//). Tất cả văn bản sau hai lần chém về phía trước cho đến khi kết thúc một dòng tạo nên một bình luận, ngay cả khi có những dấu gạch chéo về phía trước trong văn bản nhận xét.//). All text after the two forward slashes until the end of a line makes up a comment, even when there are forward slashes in the commented text.

// This is a single line comment.
x = 5;  // This is a single line comment as well!
// This is a single line comment containing a URL: http://example.com

Một nhóm các bình luận dòng đơn cho việc nhận xét rộng rãi hơn có thể, và JavaScript cũng hỗ trợ các nhận xét đa dòng (khối), như trong phần tiếp theo.

// This is an example of single line comments
// emulating multiline comments.
// After three lines or so, block comments
// are usually easier to maintain.

Bình luận Multiline (khối)

Nhận xét đa dòng của JavaScript, còn được gọi là bình luận khối, bắt đầu bằng một dấu gạch chéo phía trước theo sau là dấu hoa thị (/*) và kết thúc bằng dấu hoa thị theo sau là một dấu gạch chéo về phía trước (*/). Họ không yêu cầu một ký tự phân định nhận xét trên mọi dòng và có thể chứa các dòng mới./*) and end with an asterisk followed by a forward slash (*/). They do not require a comment delimiter character on every line and may contain newlines.

/*
This is a multiline comment
that can span as many lines
as you have the patience to
compose for your future self.
*/

Nhận xét đa dòng, còn được gọi là khối bình luận, rất hữu ích khi ghi lại các luồng logic phức tạp trong các câu lệnh khác, xử lý lỗi trong các câu lệnh thử và các thuộc tính và hành vi phức tạp trong các đối tượng JavaScript.

/*
The following tests whether a variable has a value of 1, 2, or 3, then
does something different depending on each value.
A useful if statement in production code would have more detailed
instructions, and this comment would be more detailed as well.
*/

if (x == 1) { ... instructions ... }
else if (x == 2) { ... instructions ... }
else if (x == 3) { ... instructions ... }

Sử dụng nhận xét JavaScript để ngăn chặn thực thi mã

Vì các bình luận của JavaScript không được thực thi, chúng là một cách tốt để ngăn chặn thực thi mã trong khi kiểm tra các tính năng mới. Chiến lược này cho phép bạn định vị các lỗi, dần dần loại bỏ các bình luận cho đến khi bạn tìm thấy mã có vấn đề.

Nhận xét các cuộc gọi chức năng

Khi tạo một chức năng mới, nó thường hữu ích để đảm bảo rằng chức năng không ảnh hưởng đến bất kỳ mã nào khác một cách tiêu cực hoặc bất ngờ. Một chiến lược thử nghiệm phổ biến là nhận xét chức năng mới, sau đó đảm bảo phần còn lại của chương trình vẫn chạy như mong đợi mà không có nó.

Ví dụ này nhận xét một cuộc gọi đến một phương thức mới được triển khai để đảm bảo rằng nó đã ảnh hưởng đến phần còn lại của chương trình trước khi thử nghiệm phương thức. Mặc dù có chức năng thay đổi giá trị của X X hiện tại trong mã, nhưng phương thức được nhận xét, cuộc gọi sẽ ngăn chặn việc thực thi chức năng.

function doSomething(x) {
    let val = x / 2;
    return val;
}

let x = 1;
let y = 4;
// x = doSomething(y);  // call is commented out, "x" doesn't change

Nhận xét các cơ quan chức năng - không có giá trị trả về

Nó luôn luôn cần thiết để nhận xét toàn bộ chức năng khi kiểm tra. Nếu một hàm không trả về một giá trị, bạn có thể nhận xét phần thân của chức năng bằng cách sử dụng nhận xét đa dòng JavaScript. Trong trường hợp này, chính chức năng này sẽ được gọi, nhưng giá trị của X X vẫn sẽ thay đổi vì không có gì bên trong hàm sẽ thực hiện.

let x = 1;

function doSomething(z) {
/*
    let a = z * z;
    x = a / 2;
*/
}

doSomething(12);

Nhận xét các cơ quan chức năng - với các giá trị trả về

Kỹ thuật trước đây đã giành được công việc theo cùng một cách nếu hàm ngay lập tức gán kết quả của nó cho một biến; Nhận xét cơ thể chức năng làm cho hàm trả về một giá trị không xác định. Giá trị không xác định sau đó thay đổi giá trị của X X, có thể gây nhầm lẫn cho thử nghiệm.

function doSomething(z) {
/*
    let val = z / 2;
    return val;
*/
}

let x = 1;
let y = 4;
x = doSomething(y);  // "X" would be undefined; may not be desirable

Nhận xét cẩn thận cho phép các nhà phát triển xác định các lỗi và theo dõi cách thức hoạt động của mã, nhưng nó dễ dàng đưa ra hành vi bất ngờ mà không có ý nghĩa gì trong khi bình luận, như ví dụ trước đây cho thấy. Luôn đảm bảo bạn tính đến bất kỳ sự mơ hồ nào của bạn có thể tạo ra trong thử nghiệm.

Viết bình luận JavaScript hiệu quả

Tìm kiếm sự cân bằng phù hợp giữa quá nhiều bình luận và quá ít, hoặc quyết định phong cách bình luận nào là tốt nhất cho một đoạn mã nhất định, là một cuộc tranh luận đang diễn ra giữa các nhà phát triển, một cuộc tranh luận không có khả năng được giải quyết sớm. Một số cơ sở mã tuân theo một kế hoạch bình luận chính thức, trong khi những người khác không có.

Các nhà phát triển có các sở thích khác nhau khi nào nên sử dụng các bình luận dòng hoặc đa dòng, nhưng duy trì một chiến lược nhất quán khi nhận xét mã đảm bảo rằng các bình luận rõ ràng bất kể hình thức họ thực hiện. Một số lập trình viên sử dụng nhận xét dòng đơn cho mọi thứ, trong khi những người khác sử dụng các bình luận đa dòng ở mọi nơi; Một số lập trình viên chỉ sử dụng các nhận xét khối cho tài liệu chính thức, trong khi những người khác sử dụng chúng cho bất kỳ bình luận dài nào chiếm nhiều hơn một số dòng nhất định.

Chìa khóa để bình luận JavaScript hiệu quả, bất kể bạn sử dụng phong cách nào, là nhất quán. Miễn là bình luận của bạn rõ ràng và cung cấp cho các nhà phát triển hướng dẫn về cách thức hoạt động của mã của bạn, thì nó không quan trọng chính xác những bình luận đó trông như thế nào.

Sự kết luận

Nhận xét của JavaScript Giải thích mã làm gì và làm rõ các quyết định đằng sau thiết kế mã, họ cũng ngăn chặn việc thực thi mã nếu cần thiết.

Nó rất quan trọng để sử dụng bình luận tốt; Quá ít hoặc quá nhiều bình luận sẽ làm cho mã khó hiểu hơn nếu không có bình luận nào cả. Sử dụng đúng số lượng bình luận JavaScript một cách thích hợp có thể giúp các nhà phát triển sử dụng và duy trì mã trong một thời gian dài.

Đăng ký vào giới thiệu chương trình nanodegree lập trình của chúng tôi ngay hôm nay để tìm hiểu thêm về các bình luận của JavaScript và các khái niệm lập trình khác.

Bắt đầu học