在 JavaScript 中，注释是用来解释代码、提高代码可读性或暂时禁用某段代码的文本。注释不会被 JavaScript 引擎执行，它们对程序的功能没有任何影响。JavaScript 支持两种注释方式：单行注释和多行注释。

1. 单行注释 (//)

单行注释是用 // 开头的，注释的内容从 // 到行尾，适用于简单的说明或者临时禁用一行代码。

语法：

// 这是一个单行注释
let x = 10;  // 这里也可以添加注释

示例：

let age = 30;  // 声明年龄变量
console.log(age);  // 打印年龄

2. 多行注释 (/* ... */)

多行注释用于注释多行内容，注释块从 /* 开始，到 */ 结束，可以跨越多行。

语法：

/*
  这是一个多行注释
  可以注释多行代码或说明
*/
let y = 20;

示例：

/*
  这是一个多行注释示例
  可以解释一些复杂的逻辑或临时禁用多个代码行
*/
let name = "Alice";  // 名字
let city = "New York";  // 城市
console.log(name, city);  // 打印名字和城市

3. 多行注释嵌套

JavaScript 不允许多行注释嵌套。如果在一个多行注释内再次使用 /* 和 */，会导致语法错误。

错误示例：

/*
  这是一个多行注释
  /*
    这是一个嵌套的注释
  */   // 语法错误
*/

4. 文档注释（JSDoc）

JSDoc 是一种基于注释的文档生成工具，通常用于生成代码的 API 文档。它使用特定的注释格式来提供有关函数、参数、返回值等信息。

示例：

/**
 * 计算两个数的和
 * @param {number} a - 第一个数
 * @param {number} b - 第二个数
 * @returns {number} 返回两个数的和
 */
function add(a, b) {
    return a + b;
}

JSDoc 标签：

• @param {type} name：描述函数参数的类型和名称。
• @returns {type}：描述函数的返回值类型。
• @example：提供代码示例。
• @see：引用其他相关函数或文档。

小结

• 单行注释：使用 //，适合对代码进行简短说明。
• 多行注释：使用 /* */，适合注释较长的文本或多个代码行。
• JSDoc 注释：用于自动化生成 API 文档，能够详细描述函数和类的接口。

使用注释能够帮助团队成员理解代码，提高代码可维护性，并且有助于调试和开发过程中禁用部分代码。更多详细内容请关注其他相关文章！