Hướng dẫn what are proper comments in javascript? - bình luận thích hợp trong javascript là gì?

Giới thiệu

Trong lập trình, việc xem xét đầu tiên của chúng tôi thường là máy - cách máy tính đọc và giải thích mã chúng tôi viết. Tuy nhiên, điều quan trọng không kém là xem xét những người sẽ đọc và làm việc với mã. Cho dù bạn làm việc với một nhóm hoặc một mình, bạn sẽ cần học cách bình luận và cấu trúc mã của bạn cho độc giả của con người.

Nhận xét là các chú thích trong mã nguồn của một chương trình bị thông dịch viên bỏ qua và do đó không có tác dụng đối với đầu ra thực tế của mã. Nhận xét có thể vô cùng hữu ích trong việc giải thích ý định của mã của bạn là gì hoặc nên làm.

Là một nhà phát triển, có thể gây khó chịu khi đi sâu vào mã được viết bởi một người khác không được nhận xét đúng, và thật dễ dàng để quên mã của riêng bạn có nghĩa là gì khi bạn không còn đắm chìm trong bối cảnh của một chương trình. Nhận xét mã của bạn sớm sẽ củng cố thói quen lập trình tốt trong suốt sự nghiệp của bạn để tránh những vấn đề này sau này.

Hãy cùng xem nhanh hai loại cú pháp nhận xét JavaScript khác nhau.

Nhận xét một dòng được viết với hai dấu gạch chéo về phía trước (//): comments are written with two forward slashes (//):

// This is a comment

Tất cả các ký tự ngay sau cú pháp // cho đến khi kết thúc dòng sẽ bị JavaScript bỏ qua.

Nhận xét khối, đôi khi được gọi là bình luận mutli-line, được viết bằng các thẻ mở (

/* This is
a comment */

/* This is
a comment */

/* This is
a comment */

/* This is
a comment */

/* This is
a comment */

Tất cả mọi thứ giữa thẻ mở và đóng trong khối mã ở trên sẽ bị bỏ qua.

Cả hai bình luận một dòng và nhiều dòng đều được viết ở trên mã mà họ được chỉ định để giải thích, như đã được chứng minh trong trò chơi này, Hello Hello, thế giới! thí dụ:

hello.js

// Print "Hello, World!" to the console
console.log("Hello, World!");

Khi viết bình luận, hãy thụt nhói chúng ở cùng cấp độ với mã ngay bên dưới chúng:

ocean.js

// Initialize a function
function alphabetizeOceans() {
	// Define oceans variable as a list of strings
	const oceans = ["Pacific", "Atlantic", "Indian", "Antarctic", "Arctic"];

	// Print alphabetized array to the console
	console.log(oceans.sort());
}

Lưu ý rằng nhận xét chỉ là một phần của mã như chính chương trình. Nhận xét lỗi thời có thể gây bất lợi hơn là không có bình luận nào, vì vậy hãy nhớ duy trì và cập nhật bình luận thường xuyên cùng với mọi thứ khác.

Nhận xét một dòng được gọi là bình luận nội tuyến khi chúng xuất hiện ở cuối dòng mã.inline comments when they appear at the end of a line of code.

let x = 99;    // assign numerical value to x
let y = x + 2; // assign the sum of x + 2 to y

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

Hãy nhớ rằng không có cách nào để kết thúc một bình luận dòng duy nhất trên một dòng, vì vậy hãy đảm bảo không đặt bất kỳ mã nào sau cú pháp //, như đã thấy trong ví dụ dưới đây.

broken.js

for (let i = 0; i === 10; i++) // for loop that runs ten times {
	// Running this code results in a syntax error
}

Mặc dù các bình luận nội tuyến có thể hữu ích, nhưng chúng nên được sử dụng một cách tiết kiệm - mã được đề cập trong rất nhiều bình luận nội tuyến sẽ nhanh chóng trở nên lộn xộn và do đó khó đọc.

Nhận xét cấp khối, hoặc nhận xét đa dòng, là các chú thích dài được sử dụng để giới thiệu và giải thích một phần mã. Thông thường các loại bình luận này được đặt ở đầu một tệp hoặc trước một khối mã đặc biệt phức tạp.

greet.js

/* Initialize and invoke a the greetUser function
to assign user's name to a constant and print out
a greeting. */

function greetUser() {
	const name = prompt("What is your name?");
	console.log("Hello ," + name + "! How are you?");
}

greetUser();

Đôi khi bạn cũng có thể thấy một phiên bản sửa đổi một chút của cú pháp bình luận khối, bắt đầu bằng

/* This is
a comment */

sea.js

/**
 * Initialize constant with an array of strings.
 * Loop through each item in the array and print
 * it to the console.
 */

const seaCreatures = ["Shark", "Fish", "Octopus"];

for (const seaCreature of seaCreatures) {
  console.log(seaCreature);
}

Đôi khi loại bình luận này cũng sẽ bao gồm các chi tiết về tệp lập trình, bao gồm tên tập lệnh, phiên bản và tác giả.

Nếu bạn là người mới bắt đầu trong JavaScript, bạn có thể viết càng nhiều càng cần thiết để học và hiểu mã bạn viết. Khi bạn tiến bộ như một nhà phát triển JavaScript, bạn sẽ tìm cách trả lời ý định, hoặc lý do tại sao đằng sau mã, trái ngược với cách thức hoặc cái gì.

Nhận xét cũng có thể được sử dụng để nhanh chóng và dễ dàng ngăn chặn thực thi mã cho mục đích kiểm tra và gỡ lỗi. Điều này được gọi là bình luận của người Viking.

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

math.js

// Function to add two numbers
function addTwoNumbers(x, y) {
  let sum = x + y;
  return sum;
}

// Function to multiply two numbers
function multiplyTwoNumbers(x, y) {
  let product = x * y;
  return product;
}

/* In this example, we're commenting out the addTwoNumbers
function, therefore preventing it from executing. Only the
multiplyTwoNumbers function will run */

// addTwoNumbers(3, 5);
multiplyTwoNumbers(5, 9);

Cả hai bình luận một dòng và nhận xét khối có thể được sử dụng để nhận xét mã, tùy thuộc vào kích thước của phần được chuyển đổi.

Lưu ý: Nhận xét mã chỉ nên được thực hiện trong các mục đích thử nghiệm. Không để lại đoạn mã nhận xét trong tập lệnh cuối cùng của bạn.: Commenting out code should only be done during testing purposes. Do not leave snippets of commented out code in your final script.

Khi tìm ra logic của một chương trình, việc nhận xét mã có thể chứng minh là hữu ích khi bạn xác định lỗi ở đâu hoặc đánh giá các dòng mã cung cấp nhiều tiện ích nhất.

Sự kết luận

Mã JavaScript được máy tính giải thích, nhưng sẽ luôn được đọc bởi các lập trình viên khác, bao gồm cả bản thân trong tương lai của bạn. Dành thời gian để lại chú thích thích hợp trên các phần mã phức tạp sẽ trả cổ tức trong tương lai, giúp bạn và cộng tác viên dễ dàng hiểu được mục đích của mã bạn đã viết.

Các loại bình luận trong JavaScript là gì?

Loại bình luận JavaScript đúng là gì?

Các bình luận tầm quan trọng trong JavaScript là gì?

Cái nào trong số này không phải là một bình luận hợp lệ trong JavaScript?