介绍
在编程中，我们首先考虑的是机器 - 计算机如何读取和解释我们编写的代码。 然而，同样重要的是考虑将阅读和使用代码的人。 无论您是与团队合作还是独立工作，您都需要学习为人类读者正确评论和构建代码。
注释是由解释器忽略的程序的源代码中的注释，因此对代码的实际输出没有影响。 评论可以非常有助于解释您的代码或应该做什么的意图。
作为开发人员，深入研究别人没有正确评论的代码可能会令人沮丧，当您不再沉浸在程序的上下文中时，很容易忘记自己的代码意味着什么。 早期评论您的代码将加强您的职业生涯中的良好的编程习惯，以避免这些问题。
注释语法
让我们快速浏览两种不同类型的JavaScript注释语法。
单行注释用两个正斜杠（ // ）写：
// This is a comment
紧跟在//语法之后的所有字符都将被JavaScript忽略。
阻止注释（有时称为mutli-line注释）用开头标签（ /* ）和结束标签（ */ ）编写。 如果你知道CSS，那么你已经熟悉块级注释了。
/* This is
a comment */
上述代码块中的开始和结束标记之间的所有内容将被忽略。
单行和多行评论都写在他们被指定解释的代码之上，如“Hello，World！”所示。 例：
// Print "Hello, World!" to the console
console.log("Hello, World!");
在写评论时，将它们缩小到与他们正下方的代码相同的级别：
// 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());
}
请注意，注释与程序本身一样也是代码的一部分。 过时的评论可能比没有任何评论更为有害，所以记住要定期维护和更新评论以及其他一切。
内联评论
当单行注释出现在一行代码的末尾时，它们被称为内联注释 。
let x = 99; // assign numerical value to x
let y = x + 2; // assign the sum of x + 2 to y
内联注释可用于快速注释小型特定内容片段。 由于评论只应该与其所写的确切行相关，所以这是最明显的评论类型。
记住，没有办法在一行上结束单行注释，因此请确保不将任何代码放在//语法之后，如下面的示例所示。
for (let i = 0; i === 10; i++) // for loop that runs ten times {
// Running this code results in a syntax error
}
虽然内联评论可能很有用，但应该谨慎使用 - 大量内联评论中的代码将很快变得凌乱，因此难以阅读。
阻止评论
块级注释或多行注释是用于介绍和解释一段代码的长格式注释。 通常，这些类型的注释位于文件的顶部，或者在特别复杂的代码块之前。
/* 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();
您可能还会看到稍微修改版本的块注释语法，以/**开头，并在注释块的左侧包含星号。
/**
* 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);
}
有时这种类型的评论还将包括有关编程文件的详细信息，包括脚本的名称，版本和作者。
如果您是JavaScript中的初学者，您可以根据需要编写学习和理解您编写的代码。 当您作为JavaScript开发人员进步时，您将寻求回答意图，或代码背后的原因 ，而不是如何或什么 。
评论测试代码
也可以使用注释来快速，方便地防止执行代码进行测试和调试。 这被称为“注释掉代码”。
如果您编写的某些代码中存在错误，请注释部分将阻止它们运行，并且可以帮助您精确定位问题的根源。 您也可以使用它来切换代码来测试不同的结果。
// 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);
单行注释和块注释都可用于注释掉代码，具体取决于要切换的部分的大小。
注意 ：注释代码只能在测试目的时完成。 不要在您的最终脚本中留下已注释的代码段。
在制定程序的逻辑时，注释代码可以证明是有用的，因为您可以确定哪些错误或评估提供最多实用程序的代码行。
结论
JavaScript代码由计算机解释，但会始终被其他程序员读取，包括您将来的自我。 花时间在复杂的代码段上留下正确的注释，将来会产生分红，让您和协作者更容易了解您编写的代码的意图。
