JavaScript 是否有用於註釋函式的標準？

註釋用於解釋程式碼流程並希望阻止程式碼執行。在 JavaScript 中，有兩種型別的註釋。一種是單行註釋，用於註釋單行程式碼以阻止程式碼執行或解釋程式碼。另一種是多行註釋，用於註釋程式碼塊以阻止程式碼執行或解釋新增的程式碼或程式碼。

透過添加註釋，我們也將向其他開發人員說明為什麼新增程式碼以及該特定程式碼的作用。在執行過程中，JavaScript 引擎將忽略已註釋的程式碼。

在 JavaScript 中，有兩種型別的註釋可用 – 單行 和 多行 註釋。

單行 註釋可以以 // 開頭，以行尾結束。任何以 // 開頭的行都將被引擎忽略。

// it’s a single-line comment

我們將 多行 註釋表示為正斜槓 (/) 後跟星號 (*)，並以星號 (*) 後跟正斜槓 (/) 結束。

/*
   multiple-line comment
   in JavaScript
*/

現在，我們將檢查如何使用這些單行和多行註釋來註釋函式。

註釋函式

我們可以使用單行和多行註釋來註釋 JavaScript 中的函式。現在，我們將檢查如何以標準方式註釋函式。

示例 1

在下面的示例中，我們應用單行和多行註釋來註釋函式 multiply。

<!DOCTYPE html>
<html>
<body>
   <h1>Commenting functions in js</h1>
   <p id = "result"></p>
   <script>
      /* Script to multiply few
      numbers and giving result to html tag
      */
      function multiply(a, b, c) {
         return (a*b*c)
      }
      let res = multiply(5,7,9);
      // assigning result to a p tag
      document.getElementById("result").innerHTML = res;
   </script>
</body>
</html>

示例 2

在下面的示例中，我們應用單行和多行註釋來註釋函式 multiply。

<!DOCTYPE html>
<html>
<body>
   <h1>Commenting functions in JavaScript</h1>
   <p id = "result"></p>
   <script>
      /* Script to add two
      numbers and giving result to html tag
      */
      function add(a, b) {
         return (a+b)
      }
      /*
      function add(a, b) {
         return a+b;
      }
      */
      let res = add(20,50);
      // assigning result to the p tag
      document.getElementById("result").innerHTML = res;
   </script>
</body>
</html>

在這裡，我們看到了使用單行和多行註釋來阻止程式碼塊/行執行以及解釋程式碼。

示例 3

現在，我們可以檢查另一個以標準方式註釋函式的示例。就像，

<!DOCTYPE html>
<html>
<body>
   <h1>Commenting functions in js</h1>
   <p id = "result"></p>
   <script type="text/javascript">
      /**
      * Multiply two numbers.
      * @param {number} value1, first number to multiply.
      * @param {number} value2, second number to multiply.
      * @return {number} The result of multiplying value1 and value2.
      */
      function multiply(a,b) {
         return a*b;
      }
      var value1 = 10;
      var value2 = 20;
      var res = multiply(value1, value2);
      document.getElementById("result").innerHTML = res;
   </script>
</body>
</html>

在這裡，我們解釋了 multiply

在本教程中，我們學習瞭如何使用單行和多行註釋來註釋 JavaScript 中的函式。

更新於: 2022-08-26

237 次檢視

開啟您的 職業生涯

透過完成課程獲得認證

開始學習
廣告

© . All rights reserved.