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>

始終在程式碼中編寫註釋，因為它有助於其他協作者理解您的程式碼。

列印頁面