JavaScript 是否有注释函数的标准?
javascriptweb developmentfront end technology
注释用于解释代码流程并阻止代码执行。在 JavaScript 中,有两种类型的注释。一种是单行注释,用于注释单行代码以防止代码执行或解释代码。另一种是多行注释,用于注释代码块以防止代码执行或解释添加的代码。
通过添加注释,我们将向其他开发人员清楚地说明添加代码的原因以及该特定代码将做什么。JavaScript 引擎将在执行过程中忽略注释代码。
在 JavaScript 中,有两种类型的注释可用 - 单行和多行注释。
单行注释可以以 // 开头并以行尾结束。任何以 // 开头的行,都会被引擎忽略。
// 是单行注释
我们将 多行 注释表示为斜杠 (/) 和星号 (*),并以星号 (*) 结尾,后跟斜杠 (/)。
/* 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>
在这里,我们解释了乘法
在本教程中,我们学习了使用单行和多行注释来注释 JavaScript 中的函数。