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 中的函式。

Sravani Alamanda

更新於：2022年8月26日

237 次瀏覽

開啟你的職業生涯

完成課程獲得認證

開始學習