JavaScript - 注释

JavaScript 注释

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

注释可用于多种用途，例如:-

• 解释特定代码段的用途。
• 为您自己和其他可能阅读代码的人添加文档。
• 暂时禁用或"注释掉"某个代码块，以便在不删除代码块的情况下进行测试或调试。

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

JavaScript 中的注释类型

JavaScript 中有两种常见的注释编写方式:-

• 单行注释
• 多行注释

单行注释JavaScript

单行注释可以用双斜杠 (//) 开头。注释也可以写在 // 和行尾之间。

语法

单行注释的语法如下:

<script>
// 单行注释信息
</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>

JavaScript 中的多行注释

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

语法

多行注释的语法如下 -

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

示例

在下面的示例中，我们定义了一个函数并使用多行注释对其进行了解释 -

<html>
<head>
  <title> Multi line comments </title>
</head>
<body>
  <script>
    let result = addition(1123, 8823);
    document.write("Result = " + result);  
    /* 此函数接受两个值作为参数，
    将它们相加并返回结果 */
    function addition(a, b){
      var a = 100;
      var b = 200;
      return a+b;
    }
  </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); // 打印变量值
  </script>
</body>
</html>

示例

在下面的示例中，我们定义了变量"a"和"b"。之后，我们用三行代码编写了交换"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>