JavaScript注释

JavaScript注释是一种用于在代码中添加文本注释的方法。注释不会被JavaScript解释器执行，而是仅仅用于给人类读者解释代码。这些注释可以为代码提供文档、调试和维护的便利。

单行注释

单行注释以 // 开头，后面跟注释内容。例如：

// 这是一个单行注释
var x = 5; // 可以在同一行内添加单行注释

多行注释

多行注释用于在多行代码中添加长注释。它以 /* 开始，以 */ 结束。例如：

/*
这是一个多行注释
它可以跨多行
哪怕有很多条语句
*/
var y = 10;

JSDoc注释

JSDoc注释是一种常见的JavaScript注释风格，它是一种结构化注释，使用特殊的标签来给代码添加文档信息。例如：

/**
 * 计算两个数的和
 * @param {number} x 第一个数字
 * @param {number} y 第二个数字
 * @returns {number} 两个数字的和
 */
function add(x, y) {
  return x + y;
}

在上面的例子中，注释使用了 @param 标签来描述函数的参数，使用了 @returns 标签来描述函数的返回值。这种注释风格被广泛用于生成API文档。

ESLint注释

ESLint注释是一种特殊的JavaScript注释，用于控制ESLint代码检查器的行为。例如：

/* eslint-disable no-alert */
alert('这行代码不会被ESLint检查');
/* eslint-enable no-alert */

在上面的例子中，我们使用 /* eslint-disable no-alert */ 注释禁用了 no-alert 规则，这意味着 alert 函数不会被视为错误。在禁用规则的范围内，我们可以写任意未被ESLint检查的代码。当禁用规则的范围结束后，我们可以使用 /* eslint-enable no-alert */ 注释重新启用规则。

总结

JavaScript注释是为了帮助我们在代码中添加文字说明的功能。单行注释以 // 开头，多行注释以 /* 开始，JSDoc注释和ESLint注释帮助我们在注释中添加更多的结构化信息和指令。在编写注释时，务必按照代码风格规范，并尽可能详细地解释代码的作用、参数、返回值等信息。