Javascript 简明教程

JavaScript - Comments

JavaScript Comments

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

你可以将注释用于多种用途，诸如：

  1. 解释特定代码段的目的。

  2. 向你的代码中添加文档，为自己和可能阅读它的人。

  3. 暂时禁用或“注释掉”一段代码，用于测试或调试而无需删除它。

一个好的开发人员总是会写注释来解释代码。

用 JavaScript 编写注释的常见方法有两种：

  1. Single-line comments

  2. Multi-line comments

Single-line comments in JavaScript

我们可以使用 double forward slash （//）开始单行注释。我们可以将注释写在 // 和行尾之间。

Syntax

单行注释的语法如下：

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

Example

在下边的示例中，我们使用单行注释对 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>

Example

在下边的示例中，我们注释掉“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>

Multi-line comments in JavaScript

当我们需要注释多行代码或解释较长的代码时，多行注释就很有用了。我们可以将多行注释写在 / 和 /. 之间。

Syntax

多行注释的语法如下：

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

Example

在下边的示例中，我们定义了变量“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>

始终在代码中使用注释，因为这有助于其他协作者理解你的代码。