JavaScript - 注释

JavaScript 注释

JavaScript 注释用于解释代码的目的。注释不会作为程序的一部分执行，它们仅供开发人员更好地理解代码。

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

解释特定代码段的目的。
为代码添加文档，供您自己和他人在阅读时使用。
临时禁用或“注释掉”一段代码，以便在测试或调试时进行测试，而无需删除它。

优秀的开发者总是会编写注释来解释代码。

在 JavaScript 中编写注释有两种常见方法：

单行注释
多行注释

JavaScript 中的单行注释

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

语法

单行注释的语法如下：

<script>
   // single-line comment message
</script>

示例

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

<html>
<head>
  <title> Single line comments </title>
</head>
<body>
  <script>
    // Defining the string1
    var string1 = "JavaScript";
    // Defining the string2
    var string2 = "TypeScript";
    // Printing the strings
    document.write(string1, " ", string2);
  </script>
</body>
</html>

示例

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

此外，我们可以在编写代码后添加单行代码，就像我们在 document.write() 方法之后添加的那样。

<html>
<head>
  <title> Single line comments </title>
</head>
<body>
  <script>
    var bool1 = true;
    // bool1 = false;
    document.write("The value of the bool1 is: ", bool1); // print variable value
  </script>
</body>
</html>

JavaScript 中的多行注释

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

语法

多行注释的语法如下：

<script>
   /* First line of comment message
   The second line of the comment message */
</script>

示例

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

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

<html>
<head>
  <title> Multi line comments </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>

始终在代码中编写注释，因为它有助于其他协作者理解您的代码。

打印页面