JavaScript 注释学习笔记

注释是编写高质量代码的重要组成部分，因为注释可以帮助其他人阅读和理解代码。在JavaScript中，您可以使用两种类型的注释：单行注释和多行注释。

单行注释

单行注释以双斜杠（//）开始，用于对一行代码进行注解。例如：

javascriptCopy Code
// 这是一行单行注释
console.log('Hello, World!'); // 这是另一行单行注释

在这个例子中，第一行代码有一个单行注释，它解释了这一行代码的作用。第二行代码有一个注释，描述了输出的内容。

多行注释

多行注释以 /* 开始，以 */ 结束。它们通常用于对连续的代码块进行注释。例如：

javascriptCopy Code
/*
这是一段多行注释。
它可以跨越多行，用于对代码块进行注释。
用多行注释注释掉的代码不会执行。
*/

console.log('Hello, World!');

在这个例子中，多行注释包含了多行文本，用于描述接下来的代码块的作用。

JSDoc

JSDoc是一种特殊的注释格式，用于生成JavaScript代码的文档。它是通过将特定格式的注释与代码结合使用来实现的。例如：

javascriptCopy Code
/**
 * 判断是否为偶数
 * @param {Number} n - 要检查的数字
 * @returns {Boolean} 如果是偶数则返回true，否则返回false
 */
function isEven(n) {
  return n % 2 === 0;
}

在这个例子中，我们使用JSDoc格式编写的注释来描述了isEven函数的作用和参数。这样的注释可以轻松地生成文档，以便其他人在阅读代码时能够快速地了解关键信息。

总结：在JavaScript中，注释是编写高质量代码的重要组成部分。单行注释用于对单行代码进行注解，多行注释用于对连续的代码块进行注释。使用JSDoc格式的注释可用于生成JavaScript代码的文档。