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年8月26日

237 次浏览

开启你的职业生涯

完成课程获得认证

开始学习
广告