JavaScript 注释

JavaScript 注释用于解释代码的目的。注释不会作为程序的一部分被执行，它们主要是为了让人类开发者更好地理解代码。

您可以出于各种目的使用注释，例如：

解释某段代码的目的。
为您的代码添加文档，方便自己或其他人阅读。
临时禁用或“注释掉”一段代码来进行测试或调试而不删除它。好的开发者总是会写注释来解释代码。

在 JavaScript 中有两种常见的写注释的方式：

单行注释
多行注释

单行注释

我们可以使用双斜杠 (//) 开始单行注释。我们可以在 // 和行尾之间写注释。

语法

单行注释的语法如下：

<script>
   // 单行注释信息
</script>

示例

在下面的示例中，我们使用单行注释解释了每一步 JavaScript 代码。输出中，代码打印了拼接后的字符串。

<html>
<head>
  <title> 单行注释 </title>
</head>
<body>
  <script>
    // 定义 string1
    var string1 = "JavaScript";
    // 定义 string2
    var string2 = "TypeScript";
    // 打印字符串
    document.write(string1, " ", string2);
  </script>
</body>
</html>

示例

在下面的示例中，我们将 'bool1 = false;' 这一行进行了注释，以避免执行这段代码。输出中我们可以看到 bool1 变量的值是 true，因为我们注释掉了更新 bool1 变量值的代码。

另外，我们还可以在写完代码后添加单行注释，就像我们在 document.write() 方法之后所做的那样。

<html>
<head>
  <title> 单行注释 </title>
</head>
<body>
  <script>
    var bool1 = true;
    // bool1 = false;
    document.write("bool1 的值是: ", bool1); // 打印变量值
  </script>
</body>
</html>

多行注释

当需要注释多行代码或解释较长的代码时，多行注释非常有用。我们可以在 /* 和 */ 之间写多行注释。

语法

多行注释的语法如下：

<script>
   /* 第一行注释信息
   第二行注释信息 */
</script>

示例

在下面的示例中，我们定义了 'a' 和 'b' 变量。之后，我们写了三行代码来交换 'a' 和 'b' 的值，并使用多行注释注释掉这段代码。

输出打印了 'a' 和 'b' 的实际值，因为浏览器忽略了被注释掉的代码。

<html>
<head>
  <title> 多行注释 </title>
</head>
<body>
  <script>
    var a = 100;
    var b = 200;

    /* a = a + b;
    b = a - b;
    a = a - b; */

    document.write("a = " + a + "<br>" + "b = " + b);
  </script>
</body>
</html>

在代码中总是写注释，因为这有助于其他协作者理解您的代码。